Skip to content

ci: auto-sync helm-charts chart on stable release - #259

Merged
chrisleekr merged 2 commits into
mainfrom
feat/auto-sync-helm-charts-on-release
Jul 2, 2026
Merged

ci: auto-sync helm-charts chart on stable release#259
chrisleekr merged 2 commits into
mainfrom
feat/auto-sync-helm-charts-on-release

Conversation

@chrisleekr

@chrisleekr chrisleekr commented Jul 2, 2026

Copy link
Copy Markdown
Owner

What

Adds a notify-helm-charts job to release-please.yml so that cutting a stable main release automatically opens the chart-bump PR in chrisleekr/helm-charts, instead of running that sync workflow by hand.

On release_created && ref_name == 'main', the job sends a repository_dispatch (github-app-released, version in client_payload) to helm-charts, whose github-app-sync workflow listens for it (paired PR in that repo).

Design notes

  • Runs after docker (needs: [release-please, docker]) so the dispatch never references an image tag that has not been pushed yet, and a failed image build suppresses the sync.
  • Stable-only: beta prereleases do not sync the chart.
  • permissions: {}: the cross-repo call uses the release PAT, not GITHUB_TOKEN.

Merge ordering ⚠️

The helm-charts receiver PR must be on helm-charts main before this fires (a repository_dispatch only runs a workflow present on the default branch, and the POST returns 204 even if nothing listens, so a dropped delivery is silent). Merge order: helm-charts receiver → this → the release PR.

Reviewer notes addressed

Cross-repo ordering / silent-drop hazard, needs: docker coupling, and doc-sync (CLAUDE.md + docs/build/conventions.md) all handled. The receiver-side PR carries the version-injection guard, guard tightening, and CDN-lag retry.

Summary by CodeRabbit

  • New Features

    • Added an automated release notification step for stable main releases, triggering a downstream chart update workflow after a successful release and container build.
    • The notification now includes the released version for downstream processing.
  • Documentation

    • Updated CI pipeline documentation to reflect the new release notification behavior and clarify workflow ownership details.

Add a notify-helm-charts job to release-please.yml that fires a
repository_dispatch (github-app-released, version in client_payload) to
chrisleekr/helm-charts when a stable main release is cut, so the chart-sync
workflow there opens the chart-bump PR automatically instead of by hand.

The job runs after both release-please and docker, so the dispatch never
references an image tag that has not been pushed, and a failed image build
suppresses the sync. Gated to release_created && ref_name == 'main' (beta
prereleases do not sync the chart).

Docs (CLAUDE.md + docs/build/conventions.md) note the new cross-repo dispatch.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HSfo6xtYqiQsQgEB2ht8Tv
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@chrisleekr, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 44 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: b8147c59-9fcf-4af7-ac29-41fef82bcaec

📥 Commits

Reviewing files that changed from the base of the PR and between 739d531 and 1cdb0e1.

📒 Files selected for processing (2)
  • CLAUDE.md
  • docs/build/conventions.md
📝 Walkthrough

Walkthrough

Adds a notify-helm-charts job to the release-please.yml GitHub Actions workflow that fires a repository_dispatch event to chrisleekr/helm-charts on stable main releases, using a PAT and the release tag version. Documentation in CLAUDE.md and docs/build/conventions.md is updated to reflect this behavior.

Changes

Helm Charts Dispatch on Stable Releases

Layer / File(s) Summary
Notify-helm-charts job and dispatch logic
.github/workflows/release-please.yml
New job dependent on release-please and docker, gated on release_created == 'true' and main branch, uses minimal permissions and dispatches a github-app-released repository_dispatch event with the release version via gh api using RELEASE_TOKEN.
CI pipeline documentation updates
CLAUDE.md, docs/build/conventions.md
Updates workflow ownership tables and notes to describe the new dispatch step and clarify defense-in-depth guidance for passing dynamic inputs via env:.

Estimated code review effort: 2 (Simple) | ~10 minutes

Sequence Diagram(s)

sequenceDiagram
  participant ReleasePlease as release-please job
  participant Docker as docker job
  participant NotifyHelmCharts as notify-helm-charts job
  participant HelmCharts as chrisleekr/helm-charts

  ReleasePlease->>NotifyHelmCharts: release_created == true
  Docker->>NotifyHelmCharts: docker job completed
  NotifyHelmCharts->>NotifyHelmCharts: verify github.ref_name == main
  NotifyHelmCharts->>HelmCharts: gh api repos/dispatches (event_type=github-app-released, version)
Loading

Possibly related PRs

  • chrisleekr/github-app#255: Also modifies .github/workflows/release-please.yml, establishing the release-please pipeline that this PR extends with the notify-helm-charts job.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: automating helm-charts sync on stable releases.
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.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Remove the RELEASE_TOKEN release-please setup sentence from CLAUDE.md and
docs/build/conventions.md. The token requirement is not advertised in docs to
avoid signalling attack surface on a public repo; the workflow still references
the secret in code where it is unavoidable. The env-var config reference and
security-invariant docs are unaffected.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HSfo6xtYqiQsQgEB2ht8Tv
@chrisleekr
chrisleekr merged commit f2626e9 into main Jul 2, 2026
9 of 10 checks passed
@chrisleekr
chrisleekr deleted the feat/auto-sync-helm-charts-on-release branch July 2, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant