Skip to content

fix(helm-upgrade-doc): use generic SLACK_CHANNEL secret for notifications - #643

Merged
guimoreirar merged 1 commit into
developfrom
fix/helm-upgrade-doc-generic-slack-channel
Aug 4, 2026
Merged

fix(helm-upgrade-doc): use generic SLACK_CHANNEL secret for notifications#643
guimoreirar merged 1 commit into
developfrom
fix/helm-upgrade-doc-generic-slack-channel

Conversation

@guimoreirar

Copy link
Copy Markdown
Member

Description

Makes the Slack notification channel in helm-upgrade-doc.yml a 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 (previously SLACK_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 secret SLACK_CHANNEL, or
  • explicit mapping to target a different channel without touching this workflow:
    secrets:
      SLACK_CHANNEL: ${{ secrets.SLACK_CHANNEL_OPS }}   # or any channel secret
      # ...other required secrets...

Type of Change

  • fix: Bug fix in a workflow

Migration note

Callers relying on secrets: inherit with an org secret named SLACK_CHANNEL_OPS must provide SLACK_CHANNEL instead (rename the org secret, or add SLACK_CHANNEL alongside). This supersedes #642 (which only renamed the channel-specific secret).

…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
@guimoreirar
guimoreirar requested a review from a team as a code owner August 4, 2026 17:41
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Updated workflow documentation to use the standardized SLACK_CHANNEL secret name.
    • Removed references to the previous Slack channel secret configuration.

Walkthrough

The Helm upgrade workflow documentation now uses SLACK_CHANNEL instead of SLACK_CHANNEL_OPS. It also documents how callers can map an alternate channel secret.

Changes

Helm upgrade Slack channel configuration

Layer / File(s) Summary
Secret contract and action mapping
.github/workflows/helm-upgrade-doc.yml
The workflow declares SLACK_CHANNEL, documents alternate secret mapping, and passes secrets.SLACK_CHANNEL to the shared action. Callers using SLACK_CHANNEL_OPS must update their configuration.

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

Possibly related PRs

Suggested reviewers: bedatty

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the workflow and the change from the channel-specific secret to the generic SLACK_CHANNEL secret.
Description check ✅ Passed The description explains the change, affected workflow, caller behavior, migration requirement, and change type, but it omits the template's Testing section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/helm-upgrade-doc-generic-slack-channel

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

@lerian-studio lerian-studio added size/XS PR changes < 50 lines workflow Changes to one or more reusable workflow files labels Aug 4, 2026
@lerian-studio

Copy link
Copy Markdown
Contributor

🔍 Lint Analysis

Check Files Scanned Status
YAML Lint 1 file(s) ✅ success
Action Lint 1 file(s) ✅ success
Pinned Actions 1 file(s) ✅ success
Markdown Link Check no changes ⏭️ skipped
Spelling Check 1 file(s) ✅ success
Shell Check 1 file(s) ✅ success
README Check 1 file(s) ✅ success
Composite Schema no changes ⏭️ skipped
Deployment Matrix no changes ⏭️ skipped

🔍 View full scan logs

@lerian-studio

Copy link
Copy Markdown
Contributor

🔍 PR Validation Summary

✅ PR Mergeable — no blocking failures

Check Status Blocking
Source Branch ✅ success yes
PR Title ✅ success yes
PR Description ✅ success yes
PR Size ✅ success no
Auto Labels ✅ success no
PR Metadata ✅ success no

🔍 View workflow run

@lerian-studio

Copy link
Copy Markdown
Contributor

🛡️ CodeQL Analysis Results

Languages analyzed: actions

✅ No security issues found.


🔍 View full scan logs | 🛡️ Security tab

@coderabbitai coderabbitai Bot 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.

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.

👉 Steps to fix this

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

📥 Commits

Reviewing files that changed from the base of the PR and between 66b7835 and 78e97f1.

📒 Files selected for processing (1)
  • .github/workflows/helm-upgrade-doc.yml

Comment thread .github/workflows/helm-upgrade-doc.yml
@guimoreirar
guimoreirar merged commit 4395d24 into develop Aug 4, 2026
20 checks passed
@github-actions
github-actions Bot deleted the fix/helm-upgrade-doc-generic-slack-channel branch August 4, 2026 17:46
guimoreirar added a commit that referenced this pull request Aug 4, 2026
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS PR changes < 50 lines workflow Changes to one or more reusable workflow files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants