[eas-cli] Fix update:republish command description#3888
Open
patrickwehbe wants to merge 1 commit into
Open
Conversation
|
Subscribed to pull request
Generated by CodeMention |
The update:republish command had the update:rollback description
("roll back to an existing update") copied onto it, even though all of
its flags, log output, and behavior are about republishing an update
group to a branch. Set the description to "republish an existing update
to a branch" and regenerate the matching README entry.
patrickwehbe
force-pushed
the
fix/update-republish-description
branch
from
fddff27 to
6ac08bd
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
eas update:republish --helpshows the description "roll back to an existing update", which belongs to the separateeas update:rollbackcommand. It looks like that string was copied over when the command was set up. Everything else aboutupdate:republishis about republishing an update group to a branch: its flags (--branch,--group,--destination-branch, ...), its log output ("The republished update group will appear..."), and therepublishAsynccall it runs. So the description is just wrong and is confusing in the help output and the generated CLI reference.For comparison,
update/rollback.tskeeps its own correct description, "roll back to an embedded update or an existing update".How
Changed the
static descriptionon theUpdateRepublishcommand from "roll back to an existing update" to "republish an existing update to a branch", then updated the matching lines inpackages/eas-cli/README.mdso the generated reference stays in sync. The README change mirrors exactly whatoclif readmeproduces for this command (verified by regenerating and diffing); I applied just the two republish lines by hand to keep this PR scoped to the fix and avoid pulling in unrelated regenerated sections.Also added a bug-fix entry to
CHANGELOG.md.Test Plan
yarn buildfor the monorepo succeeds with the change.eas update:republish --helpnow prints "republish an existing update to a branch" in both the summary line and the DESCRIPTION block, andeas update:rollback --helpis unaffected.