Skip to content

fix: docs drift, plus two breaking flag fixes#227

Merged
madebydavid merged 3 commits into
mainfrom
docs/all-missing-flags-and-descriptions
Jul 16, 2026
Merged

fix: docs drift, plus two breaking flag fixes#227
madebydavid merged 3 commits into
mainfrom
docs/all-missing-flags-and-descriptions

Conversation

@madebydavid

@madebydavid madebydavid commented Jul 16, 2026

Copy link
Copy Markdown
Member

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

  1. --useDemoCredentials now only accepts true or false

It was a free-form string flag it is now constrained with options: ['true', 'false'], so oclif rejects bad values up front:

$ shipthis game create --useDemoCredentials yes
Error: Expected --useDemoCredentials=yes to be one of: true, false
  1. -g is no longer an alias for --gcpProjectId

There was a conflict on -g - it should only be used for gameId

@madebydavid
madebydavid marked this pull request as ready for review July 16, 2026 15:10
@madebydavid
madebydavid requested a review from Copilot July 16, 2026 15:10
@madebydavid

Copy link
Copy Markdown
Member Author

requested a review as many files changed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 game and apple command docs (e.g., --dryRun, --platform, --logout, --testGroupName, Liquid Glass icon path flags).
  • Removed the non-existent -f/--forceStep flag from game wizard docs and clarified the PLATFORM argument.
  • 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.

Comment thread docs/game/create.md Outdated
Comment thread docs/game/details.md
@madebydavid

Copy link
Copy Markdown
Member Author

couple of good spots from the review - changing the code for useDemoCredentials and the overlapping flags.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Comment thread src/constants/index.ts
@madebydavid madebydavid changed the title docs: updating flags and descriptions for many commands fix: docs drift, plus two breaking flag fixes Jul 16, 2026
@madebydavid
madebydavid merged commit d0824ba into main Jul 16, 2026
1 check passed
@madebydavid
madebydavid deleted the docs/all-missing-flags-and-descriptions branch July 16, 2026 15:35
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