Skip to content

chore: change slack channel to helm doc upgrade notify workflow - #642

Merged
guimoreirar merged 9 commits into
mainfrom
develop
Aug 4, 2026
Merged

chore: change slack channel to helm doc upgrade notify workflow #642
guimoreirar merged 9 commits into
mainfrom
develop

Conversation

@guimoreirar

@guimoreirar guimoreirar commented Aug 4, 2026

Copy link
Copy Markdown
Member
Lerian

GitHub Actions Shared Workflows


Description

Type of Change

  • feat: New workflow or new input/output/step in an existing workflow
  • fix: Bug fix in a workflow (incorrect behavior, broken step, wrong condition)
  • perf: Performance improvement (e.g. caching, parallelism, reduced steps)
  • refactor: Internal restructuring with no behavior change
  • docs: Documentation only (README, docs/, inline comments)
  • ci: Changes to self-CI (workflows under .github/workflows/ that run on this repo)
  • chore: Dependency bumps, config updates, maintenance
  • test: Adding or updating tests
  • BREAKING CHANGE: Callers must update their configuration after this PR

Breaking Changes

None.

Testing

  • YAML syntax validated locally
  • Triggered a real workflow run on a caller repository using @this-branch or the beta tag
  • Verified all existing inputs still work with default values
  • Confirmed no secrets or tokens are printed in logs
  • Checked that unrelated workflows are not affected

Caller repo / workflow run:

Related Issues

Closes #

@guimoreirar guimoreirar self-assigned this Aug 4, 2026
@guimoreirar
guimoreirar requested a review from a team as a code owner August 4, 2026 17:08
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Updated Helm upgrade workflow guidance to use the generic SLACK_CHANNEL secret.
    • Clarified how callers can map channel-specific secrets when using inherited secrets.
    • Improved consistency in configuring Slack notifications for Helm upgrade workflows.

Walkthrough

The Helm upgrade documentation workflow now documents, declares, and passes the generic SLACK_CHANNEL secret. Callers using SLACK_CHANNEL_DEVOPS must update their secret mapping.

Changes

Helm upgrade Slack notification

Layer / File(s) Summary
Document and wire Slack channel secret
.github/workflows/helm-upgrade-doc.yml, docs/helm-upgrade-doc.md
The workflow and documentation use SLACK_CHANNEL. The documentation explains exact-name requirements for secrets: inherit and explicit mapping for differently named secrets.

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

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: bedatty, ferr3ira-gabriel

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description omits the required change summary and migration details, leaves the workflow run link empty, and does not document the unchecked validation items. Add a concise change summary, explain the secret rename and caller impact, provide the workflow run link, and complete the required testing checks.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the Slack channel update for the Helm documentation upgrade notification workflow.
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 develop

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

lerian-studio commented Aug 4, 2026

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 1 file(s) ✅ success
Spelling Check 2 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

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

🛡️ 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:
- Line 61: Update the reusable workflow contract and its callers to handle the
SLACK_CHANNEL_DEVOPS to SLACK_CHANNEL_OPS rename consistently: either retain
SLACK_CHANNEL_DEVOPS as a temporary fallback or migrate every caller and update
docs/helm-upgrade-doc.md to SLACK_CHANNEL_OPS. Mark the rename as a breaking
change in the relevant workflow documentation or release metadata, while
preserving Slack notifications for existing callers.
🪄 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: be8e3060-2031-43dd-8ab6-882d4b042bc3

📥 Commits

Reviewing files that changed from the base of the PR and between 9fe6462 and 66b7835.

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

Comment thread .github/workflows/helm-upgrade-doc.yml Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Aug 4, 2026
bedatty
bedatty previously approved these changes Aug 4, 2026
…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

@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: Preserve backward compatibility for the Slack channel
secret used by the reusable workflow: update the notification steps around the
SLACK_CHANNEL references to fall back to SLACK_CHANNEL_DEVOPS when SLACK_CHANNEL
is unset, or update all callers and explicitly document the rename as breaking.
Verify repository callers and references to helm-upgrade-doc and both secret
names before completing the change.
🪄 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: 96c8d052-2f14-4d8e-91e0-083130214838

📥 Commits

Reviewing files that changed from the base of the PR and between 66b7835 and 4395d24.

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

Comment thread .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
guimoreirar and others added 2 commits August 4, 2026 15:09
…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
@lerian-studio lerian-studio added the documentation Improvements or additions to documentation label Aug 4, 2026

@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 blank line at the identified location in the blockquote
within helm-upgrade-doc.md so the consecutive blockquote paragraphs remain
contiguous and comply with 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: abae83a4-480c-4050-b56d-846c6977ed25

📥 Commits

Reviewing files that changed from the base of the PR and between 4395d24 and 79ea937.

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

Comment thread docs/helm-upgrade-doc.md
@guimoreirar
guimoreirar merged commit a3ba596 into main Aug 4, 2026
20 checks passed
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 workflow Changes to one or more reusable workflow files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants