-
Notifications
You must be signed in to change notification settings - Fork 85
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
[eas-cli] fix README.md
command files URLs
#2318
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/changelog-entry bug-fix Fix command source files URLs in autogenerated |
✅ Thank you for adding the changelog entry! |
Size Change: -788 B (0%) Total Size: 51.4 MB
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2318 +/- ##
=======================================
Coverage 53.68% 53.68%
=======================================
Files 525 525
Lines 19190 19190
Branches 4054 4054
=======================================
Hits 10301 10301
Misses 8162 8162
Partials 727 727 ☔ View full report in Codecov by Sentry. |
sjchmiela
approved these changes
Apr 10, 2024
This was referenced Sep 9, 2024
This was referenced Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
URLs to our command source files are broken in README.
@gabimoncha caught it in #2317
Instead of pointing to
packages/eas-cli/src/commands/xyz
URLs point tosrc/commands/xyz
(incorrect, nonexistent location)Example: https://github.com/expo/eas-cli/blob/main/packages/eas-cli/README.md#eas-accountlogin
How
Since our
README
generation process is automated by the oclif tool we should fix thepatch-readme
script we have to actually do its job and patchREADME
correctly and changesrc/commands
topackage/eas-cli/src/commands
. TheREADME
generation process is run every time we do a new release.eas-cli/packages/eas-cli/package.json
Line 218 in dbb070f
Test Plan
Test locally by running
yarn version
inpackages/eas-cli
dir and inspecting the generatedREADME
.Do a new release after merging it to see that it works on
main
.