-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Toolkit Cleanup] Yard doc: step 2 – rename module Helpers -> Helper #199
Conversation
2426336
to
aa30ec4
Compare
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a very nice alignment change. Review notes:
✅ Review the code changes [ they were very boring and exactly what I expected]
✅ [...] Run the existing tests and ensure they still compile and pass
✅ Run bundle exec yard doc to generate the documentation. Open yard-doc/index.html in your browser and ensure that the modules and helpers are consistently classified under a common Fastlane > Helper hierarchy. [they were, and this does make it significantly nicer]
I didn't run any lanes, as I have confidence that this change works well – I instead used rg helpers && rg Helpers
to try to find any unresolved instances of this. All that came back were comments and files in the .xcproject for drawText
.
One thing to note – we'll likely need to update WPAndroid for this, as it contains calls to these helpers (though AFAICT only its own local copies – the Fastfile
doesn't seem to reference them, so it might just be possible to delete the helpers
directory from that project altogether – just noting it here because we should take special care when bringing this update to that project).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
I double checked that there are no remaining instances of Helpers
in the project.
@jkmassel raised a very good point about WPAndroid. I'd say it's a good time to remove all the local instances and pull everything in the toolkit. IIRC, for the most part we can just get rid of the local instances and call the toolkit equivalent without any other chance.
That's a good point. I'll definitively try to get rid of the versions in WPAndroid. Unfortunately quickly So might not be as trivial / immediate (I mean I could also just blindly delete the local actions and helpers, sacrifice a lamb and pray that using the release-toolkit ones will behave the same… but I prefer to be safe than sorry 😅, even if that means taking more time to double-check). But definitively on my roadmap for sure. |
WPAndroid local helpers and actions removal tracked in #204 |
This PR sits on top of #198 and simply renames the
module Helpers
intomodule Helper
for consistency both in code and in the generated documentation.Why?
Fastlane::Helper
(singular).Fastlane::Helper
but others are namedFastlane::Helpers
.This discrepancy makes the code inconsistent but also makes the YARD documentation incoherent, by splitting some modules and helpers in one module and other helpers in another.
How?
This is mainly a "Find & Replace All" on the codebase for
module Helpers
andFastlane::Helpers
to its singular form instead. I made it a dedicated PR for easier review because it touches many files and already makes quite a big diff all by itself.To Test
bundle install && bundle exec rspec
to run the existing tests and ensure they still compile and passbundle exec fastlane run <action_name>
to ensure that they still work, though be careful about potential side effects triggered by those actions (we wouldn't want to cut a release or push a new beta unexpectedly)bundle exec yard doc
to generate the documentation. Openyard-doc/index.html
in your browser and ensure that the modules and helpers are consistently classified under a commonFastlane
>Helper
hierarchy