Skip to content

docs(helm-upgrade-doc): update Slack channel secret to generic SLACK_CHANNEL - #644

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

docs(helm-upgrade-doc): update Slack channel secret to generic SLACK_CHANNEL#644
guimoreirar merged 2 commits into
developfrom
fix/helm-upgrade-doc-slack-channel-generic

Conversation

@guimoreirar

Copy link
Copy Markdown
Member

Description

Follow-up to #643. That PR merged the generic SLACK_CHANNEL secret into the helm-upgrade-doc workflow but left docs/helm-upgrade-doc.md referencing the old SLACK_CHANNEL_DEVOPS. This updates the doc to SLACK_CHANNEL, with a note that callers map any channel secret to it (e.g. SLACK_CHANNEL: ${{ secrets.SLACK_CHANNEL_OPS }}).

Resolves the CodeRabbit doc-consistency finding raised on #642/#643.

Type of Change

  • docs: Documentation only

Migration

None — doc-only.

…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
@guimoreirar
guimoreirar requested a review from a team as a code owner August 4, 2026 18:02
@lerian-studio lerian-studio added size/XS PR changes < 50 lines documentation Improvements or additions to documentation labels Aug 4, 2026
@lerian-studio

lerian-studio commented Aug 4, 2026

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

lerian-studio commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

🔍 Lint Analysis

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

🔍 View full scan logs

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Updated Helm upgrade guidance to use the generic SLACK_CHANNEL secret.
    • Added an example showing how to map channel-specific secrets.
    • Clarified that inherited secrets must use the exact SLACK_CHANNEL name.

Walkthrough

The Helm upgrade documentation replaces SLACK_CHANNEL_DEVOPS with SLACK_CHANNEL. It explains exact-name matching under secrets: inherit, absent-secret behavior, and explicit mapping for alternate secret names.

Changes

Helm upgrade documentation

Layer / File(s) Summary
Document generic Slack channel secret
docs/helm-upgrade-doc.md
Replaces SLACK_CHANNEL_DEVOPS with SLACK_CHANNEL. Documents inheritance requirements, skipped notifications when the secret is absent, and explicit mapping for differently named secrets.

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

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation file and the Slack secret name update.
Description check ✅ Passed The description explains the change, identifies it as documentation-only, and states that no migration is required.
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-slack-channel-generic

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

@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 `@docs/helm-upgrade-doc.md`:
- Line 109: Update the SLACK_CHANNEL documentation to state that callers using
differently named secrets, such as SLACK_CHANNEL_OPS, must replace secrets:
inherit with an explicit secrets: mapping covering every required secret,
including SLACK_CHANNEL, so Slack notifications receive the channel value.
🪄 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: 7d952b16-3272-4736-ae9d-388bd15211a3

📥 Commits

Reviewing files that changed from the base of the PR and between 4395d24 and 45a8964.

📒 Files selected for processing (1)
  • docs/helm-upgrade-doc.md

Comment thread docs/helm-upgrade-doc.md
…nherit

Address CodeRabbit: note that secrets: inherit matches by name and does not
rename SLACK_CHANNEL_OPS to SLACK_CHANNEL — callers need a secret named
SLACK_CHANNEL, or an explicit secrets mapping (inherit cannot be combined with an
explicit secrets block).

X-Lerian-Ref: 0x1

@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 `@docs/helm-upgrade-doc.md`:
- Line 119: Remove the standalone empty blockquote marker on line 119 in the
documentation so the blockquote has no blank quoted line and satisfies
markdownlint MD028.
🪄 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: 08b08aee-3bba-4c4b-a3f4-a82af2c845f5

📥 Commits

Reviewing files that changed from the base of the PR and between 45a8964 and 600e758.

📒 Files selected for processing (1)
  • docs/helm-upgrade-doc.md

Comment thread docs/helm-upgrade-doc.md
@guimoreirar
guimoreirar merged commit 79ea937 into develop Aug 4, 2026
19 checks passed
@github-actions
github-actions Bot deleted the fix/helm-upgrade-doc-slack-channel-generic branch August 4, 2026 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS PR changes < 50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants