Skip to content

docs(cli): describe --stack-name as the Secrets Manager secret prefix - #2278

Merged
cristim merged 1 commit into
mainfrom
docs/2097-configure-help-text
Oct 19, 2026
Merged

cristim merged 1 commit into
mainfrom
docs/2097-configure-help-text

Conversation

@cristim

@cristim cristim commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

Refs #2097 (item 9). Item 10 is an owner decision and stays open.

The --stack-name help text in configure azure and configure gcp said "CUDly CloudFormation stack name", but the flag only prefixes the AWS Secrets Manager secret name. No CloudFormation API is called:

  • configure_azure.go:145 builds <stack>-AzureCredentials, used at :206
  • configure_gcp.go:122 builds <stack>-GCPCredentials, used at :190

The new help text says that. Flag names are unchanged. The multi_service_stats.go comment no longer cites the MCP server's post-purchase offer, which is a monorepo leftover. No test asserts the help text.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that the Azure and GCP stack-name values prefix the corresponding AWS Secrets Manager secret names.
    • Updated the signup URL comment to identify it as a shared constant alias.

…comment

--stack-name is only the prefix of the AWS Secrets Manager secret
(<stack-name>-AzureCredentials / -GCPCredentials); no CloudFormation
API is called. Reword the flag help accordingly and drop the
monorepo-only MCP server reference from the archeraSignupURL comment.

Refs #2097

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: LeanerCloud/cloud-commitments-cli/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 5bdf7df6-fb1b-4478-b520-82301c8878b2
📥 Commits

Reviewing files that changed from the base of the PR and between ff805e2 and eba9f9a.

📒 Files selected for processing: 3
  • cmd/configure_azure.go
  • cmd/configure_gcp.go
  • cmd/multi_service_stats.go

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

📝 Walkthrough

The Azure and GCP --stack-name help text now describes the value as a prefix for an AWS Secrets Manager secret. A comment now identifies archeraSignupURL as an alias for a shared constant.

Changes: CLI Description Updates

Layer / File(s) Summary
Help text and comment updates
cmd/configure_azure.go, cmd/configure_gcp.go, cmd/multi_service_stats.go
The Azure and GCP help text describes the stack name as a secret-name prefix. The archeraSignupURL comment identifies the shared pkg/common constant as its source.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: iamjsd

Merge Risk: ⚪ Minimal · up to eba9f

The help now accurately describes how the Azure and GCP commands locate credential secrets. No stack-creation behavior changed, and no material merge risk remains.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 3 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: updating the CLI documentation to define --stack-name as the Secrets Manager secret prefix.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
  • Fix all pre-merge checks with AI
✨ Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cristim

cristim commented Oct 19, 2026

Copy link
Copy Markdown
Member Author

Review C (independent, claude-cc-libs-rev-C): APPROVE at eba9f9a

  • --stack-name binds to StackName (configure_azure.go:113, configure_gcp.go:88).
  • Its only uses: it builds <stack>-AzureCredentials / <stack>-GCPCredentials (:145 / :122); that name is a prefix filter for store.ListSecrets (:148 / :125) on AWSSecretsStore (secrets_store.go:32); and it appears in the result printout (configure_azure.go:599). No CloudFormation call exists.
  • docs/cli/cloud-setup.md already describes it as a Secrets Manager prefix (lines 16, 30, 99), so no docs change is needed.
  • The multi_service_stats.go comment stays accurate: archeraSignupURL aliases common.ArcheraSignupURL (:206), and the MCP claim was unverifiable from this repo.

@cristim

cristim commented Oct 19, 2026

Copy link
Copy Markdown
Member Author

Review D (independent, claude-cc-libs-rev-D): APPROVE at eba9f9a

  • Item 9 is correct as fixed. --stack-name only builds the Secrets Manager name (configure_azure.go:145, configure_gcp.go:122).
  • Only the two help strings and one comment changed. No flag name, default or behavior changed.
  • Local checks pass: go build -o /dev/null ./..., go vet ./cmd/... and go test ./cmd/....
  • No stale "CloudFormation" wording remains in README or docs.

@cristim

cristim commented Oct 19, 2026

Copy link
Copy Markdown
Member Author

Merge gate verdict (claude-cc-libs)

Every gate holds at head eba9f9a:

  • Two independent reviews approve the reviewed head eba9f9a. The branch was then updated from main, and the PR diff is byte-identical to the reviewed diff (compared mechanically).
  • CI is green on eba9f9a, which is the reviewed change on top of current main.
  • 0 unresolved threads; MERGEABLE/CLEAN.

CodeRabbit is waived as a merge gate under the 2026-10-19 decision. Squash-merging.

@cristim
cristim merged commit 9caa37e into main Oct 19, 2026
12 checks passed
@cristim
cristim deleted the docs/2097-configure-help-text branch October 20, 2026 15:10
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.

1 participant