fix: docs drift, plus two breaking flag fixes#227
Merged
Conversation
madebydavid
marked this pull request as ready for review
July 16, 2026 15:10
Member
Author
|
requested a review as many files changed |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the ShipThis CLI reference docs to match the current command help output, adding newly available flags/examples and removing a documented flag that doesn’t exist.
Changes:
- Added/updated flags and examples across
gameandapplecommand docs (e.g.,--dryRun,--platform,--logout,--testGroupName, Liquid Glass icon path flags). - Removed the non-existent
-f/--forceStepflag fromgame wizarddocs and clarified thePLATFORMargument. - Refreshed topic/index docs to include missing subcommand sections and links, and corrected autocomplete argument optionality.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/game/create.md | Adds missing create flags (GCP, demo credentials, Liquid Glass icon path) to the generated help output. |
| docs/game/ship.md | Documents --dryRun flag and adds a corresponding example. |
| docs/game/status.md | Adds --platform flag and example for checking status by platform. |
| docs/apple/login.md | Adds --logout, example, and security-related description about password handling. |
| docs/game/ios/app/addTester.md | Adds --quiet, --self, --testGroupName flags and example. |
| docs/game/details.md | Adds --liquidGlassIconPath flag to the details command help output. |
| docs/game/wizard.md | Removes non-existent --forceStep and updates PLATFORM arg description/options display. |
| docs/game/ios/app.md | Adds the missing game ios app addTester section and refreshes help blocks for create/sync. |
| docs/game/ios.md | Adds link to game ios wizard. |
| docs/autocomplete.md | Marks SHELL argument as optional ([SHELL]). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
couple of good spots from the review - changing the code for |
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
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.
Tool assisted PR - diffed the auto-gen docs against the actual docs to find where they'd drifted.
It started as a docs-only pass, but chasing two of the discrepancies turned up real bugs in the CLI itself, so this PR also changes the flag surface.
Two of those changes are breaking — details below.
Breaking changes
--useDemoCredentialsnow only acceptstrueorfalseIt was a free-form string flag it is now constrained with
options: ['true', 'false'], so oclif rejects bad values up front:-gis no longer an alias for--gcpProjectIdThere was a conflict on
-g- it should only be used forgameId