Skip to content

docs(cli): port the git migrations toggle from volcano-cli - #175

Merged
swkeever merged 1 commit into
mainfrom
skeever/port-cli-git-docs
Nov 13, 2026
Merged

swkeever merged 1 commit into
mainfrom
skeever/port-cli-git-docs

Conversation

@swkeever

Copy link
Copy Markdown
Contributor

Why

Kong/volcano-cli#490 changed docs/git.md after #170's snapshot of the CLI docs. Kong/volcano-cli#489 deletes docs/, so this carries the change over first.

What changed

  • content/cli/git.md: the docs/git.md diff from volcano-cli 19e81be to 65b50e7, applied as is.

Testing

  • pnpm lint:docs content and pnpm check:links: pass.

🤖 Generated with Claude Code

@swkeever
swkeever enabled auto-merge November 13, 2026 17:19
Copilot AI balanced review requested due to automatic review settings November 13, 2026 17:19
@github-actions

Copy link
Copy Markdown
Contributor

AI review: no P0-P2 findings

Reviewed ff12c10. Run log

Docs-only change. It ports volcano-cli#490's docs/git.md diff into content/cli/git.md, adding the volcano git migrations on|off [--yes] command to the operations table, the status description, the local-mode list, and a new "Applying database migrations on push" section. The text matches the platform's existing apply_migrations docs in platform/projects/git-deploy.md, and the relative link to databases.md resolves. Risk is low.

⚪ P3

  • content/cli/git.md:341 List of commands that need a connected repository was not updated to include migrations

Not checked: The AI review read the diff, the code, and the PR's text; it ran no tests or builds and read nothing outside this repository.

  • Whether volcano git migrations is in a released CLI version yet; spec/writing.md says to merge docs for a new behavior only once it has shipped.
  • Whether the CLI's real behavior matches the page: the confirmation prompt, --yes, what volcano git status prints, and the error on a project with nothing connected or in local mode.
  • Verify that the released Volcano CLI supports the documented migrations toggle, confirmation, and status behavior.

Human review: not needed

@swkeever
swkeever added this pull request to the merge queue Nov 13, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The documented migrations command is absent from the latest published CLI release, so publication must wait for a release containing the feature to meet the documentation release policy.

1 open issue
What changed in this PR

Ports the Git migration-toggle documentation missed by the CLI docs snapshot, preserving it as documentation moves into this repository.

Changes:

  • Documents volcano git migrations on|off, confirmation, and migration behavior on push.
  • Explains branch protection, baselining, failure behavior, and disabling migrations.
  • Updates command listings, status output, and local-mode guidance.
File Description
content/​cli/​git.md Adds migration-toggle guidance and updates related Git command documentation.

Review effort: Balanced

Comment thread content/cli/git.md
Comment on lines +287 to +288
volcano git migrations on # asks for confirmation; --yes skips it
volcano git migrations off
Merged via the queue into main with commit 7a86703 Nov 13, 2026
18 checks passed
@swkeever
swkeever deleted the skeever/port-cli-git-docs branch November 13, 2026 17:23
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