fix(helm-upgrade-doc): use generic SLACK_CHANNEL secret for notifications - #643
Conversation
…ions The notification channel was a channel-specific secret (SLACK_CHANNEL_OPS, previously SLACK_CHANNEL_DEVOPS), so switching channels meant renaming the secret here and opening a PR in shared-workflows. Rename it to a generic SLACK_CHANNEL so callers control the channel from their own workflow (org secret SLACK_CHANNEL via secrets: inherit, or an explicit secret mapping to target a different channel) — no change to this shared workflow needed to switch channels. X-Lerian-Ref: 0x1
Summary by CodeRabbit
WalkthroughThe Helm upgrade workflow documentation now uses ChangesHelm upgrade Slack channel configuration
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Lint Analysis
|
🔍 PR Validation Summary✅ PR Mergeable — no blocking failures
|
🛡️ CodeQL Analysis ResultsLanguages analyzed: ✅ No security issues found. 🔍 View full scan logs | 🛡️ Security tab |
There was a problem hiding this comment.
Warning
CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.
Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/helm-upgrade-doc.yml:
- Around line 17-24: Update the caller guidance in docs/helm-upgrade-doc.md to
replace SLACK_CHANNEL_DEVOPS with SLACK_CHANNEL and explicitly document the
migration for existing secrets: inherited callers must rename or map their old
channel secret to SLACK_CHANNEL. Ensure the documentation matches the workflow’s
current secret contract.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: ASSERTIVE
Plan: Pro
Run ID: e2ac28b9-d92e-40a0-8786-8e78222cdf5d
📒 Files selected for processing (1)
.github/workflows/helm-upgrade-doc.yml
…CHANNEL Follow-up to #643 (which merged the generic SLACK_CHANNEL in the workflow but left the doc stale). docs/helm-upgrade-doc.md still listed SLACK_CHANNEL_DEVOPS; update it to SLACK_CHANNEL with a note on mapping a channel secret in the caller. Closes the CodeRabbit doc-consistency finding. X-Lerian-Ref: 0x1
Description
Makes the Slack notification channel in
helm-upgrade-doc.ymla generic secret so switching channels never requires a PR in this shared-workflows repo.Before: the channel came from a channel-named secret
SLACK_CHANNEL_OPS(previouslySLACK_CHANNEL_DEVOPS). Changing channel meant renaming the secret here and opening a PR (e.g. #642).After: the workflow declares and uses a generic
SLACK_CHANNEL. Callers control the channel from their own workflow:secrets: inherit→ uses the caller org/repo secretSLACK_CHANNEL, orType of Change
fix: Bug fix in a workflowMigration note
Callers relying on
secrets: inheritwith an org secret namedSLACK_CHANNEL_OPSmust provideSLACK_CHANNELinstead (rename the org secret, or addSLACK_CHANNELalongside). This supersedes #642 (which only renamed the channel-specific secret).