docs(cli): describe what configure-gcp actually checks first by cristim · Pull Request #2258 · LeanerCloud/cloud-commitments-cli · GitHub
Skip to content

docs(cli): describe what configure-gcp actually checks first - #2258

Merged
cristim merged 1 commit into
mainfrom
docs/gcp-setup-preflight
Oct 17, 2026
Merged

docs(cli): describe what configure-gcp actually checks first#2258
cristim merged 1 commit into
mainfrom
docs/gcp-setup-preflight

Conversation

@cristim

@cristim cristim commented Oct 17, 2026

Copy link
Copy Markdown
Member

Closes #2257

Summary

The configure-gcp "What it does" section of docs/cli/cloud-setup.md repeated a sentence from configure-azure about creating Azure resources. That is wrong for GCP, which creates no Azure resources. This PR corrects that sentence, fixes the other stale facts in the same section, and documents the new cleanup behaviour. The configure-azure section is unchanged.

  • Preflight: configure-gcp first loads the AWS config, honouring --profile, and stops there if that fails, before it creates any GCP resource or key (cmd/configure_gcp.go:153, :302-312). It resolves AWS credentials only when the secret is written.
  • Steps:
    • Adds the gcloud auth application-default login step.
    • The project listing is an SDK call with its own [R]un ... or [S]kip prompt, and it runs unless you enter s/skip.
    • gcloud config set project runs without a prompt.
    • Both custom roles are named.
    • The key is minted through the SDK into a private temporary directory, and the local copy is removed after upload.
    • The "[r]un, [S]kip (default)" note now mentions the listing exception.
  • Cleanup:

Evidence

  • An independent non-author reviewer (sonnet, high) checked every changed sentence against cmd/configure_gcp.go on origin/main, citing file:line for each, over two passes.
    • Pass 1 caught an accidental edit to the configure-azure section. It is reverted, so git diff touches only the configure-gcp section.
    • Pass 2 found no actionable findings at 02f07b1.
  • markdownlint and the pre-commit hooks pass.

🤖 Generated with Claude Code

@cristim @claude
docs(cli): describe what configure-gcp actually checks first
02f07b1 
Replace the copied Azure preflight sentence with the real behavior (AWS
config load only, before any GCP step) and correct the wizard steps: ADC
login, SDK project listing with its own prompt, both custom roles, and the
SDK-minted key in a private temp dir.

Closes #2257

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cristim cristim added priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline impact/few Limited audience effort/xs Trivial / one-liner type/docs Documentation triaged Item has been triaged labels Oct 17, 2026
@coderabbitai

coderabbitai Bot commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

@cristim

cristim commented Oct 17, 2026

Copy link
Copy Markdown
Member Author

@cristim
cristim merged commit 0f7b9b6 into main Oct 17, 2026
12 checks passed
@cristim
cristim deleted the docs/gcp-setup-preflight branch October 17, 2026 15:59
@cristim cristim mentioned this pull request Oct 17, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

effort/xs Trivial / one-liner impact/few Limited audience priority/p3 Polish / idea / may never ship severity/low Minor harm triaged Item has been triaged type/docs Documentation urgency/eventually No deadline

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs(cli): configure-gcp section repeats the Azure-only AWS-preflight sentence

1 participant

@cristim