Skip to content
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 2 commits into from
Apr 11, 2024

Conversation

szdziedzic
Copy link
Member

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 to src/commands/xyz (incorrect, nonexistent location)

Example: https://github.com/expo/eas-cli/blob/main/packages/eas-cli/README.md#eas-accountlogin

Screenshot 2024-04-10 at 13 58 13

How

Since our README generation process is automated by the oclif tool we should fix the patch-readme script we have to actually do its job and patch README correctly and change src/commands to package/eas-cli/src/commands. The README generation process is run every time we do a new release.

"version": "yarn oclif readme && node scripts/patch-readme && git add README.md",

Test Plan

Test locally by running yarn version in packages/eas-cli dir and inspecting the generated README.

Do a new release after merging it to see that it works on main.

@szdziedzic
Copy link
Member Author

/changelog-entry bug-fix Fix command source files URLs in autogenerated README

Copy link

✅ Thank you for adding the changelog entry!

Copy link

Size Change: -788 B (0%)

Total Size: 51.4 MB

Filename Size Change
./packages/eas-cli/dist/eas-linux-x64.tar.gz 51.4 MB -788 B (0%)

compressed-size-action

Copy link

codecov bot commented Apr 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.68%. Comparing base (40afed1) to head (a1e7c42).

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.
📢 Have feedback on the report? Share it here.

@szdziedzic szdziedzic merged commit 0ab64d5 into main Apr 11, 2024
9 checks passed
@szdziedzic szdziedzic deleted the @szdziedzic/fix-readme-eas-cli-paths branch April 11, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants