Conversation
Two changes: 1. Regenerate helm/README.md after the release-please-driven bump (Chart.yml + values.yml from 2.0.12 -> 3.0.0 left the rendered README still showing 2.0.12 because helm-docs reads values.yml at regen time, and release-please does not invoke helm-docs). Without this fix the helm-docs-check CI gate stays red on main and blocks the release.yml workflow. 2. Add a follow-up job to .github/workflows/release-please.yml that runs after release-please opens its PR. It checks out the PR branch, regenerates helm/README.md, and pushes the result back to the same branch. The next release-please bump will produce a self-consistent PR — chart files and rendered README in sync, no manual regen needed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
After merging the release-please PR (#59) for v3.0.0, the helm-docs-check job on main went red. Cause: release-please bumps
helm/Chart.ymlandhelm/values.ymlvia thetype: genericupdater (line-level value replacement) but never invokeshelm-docs.helm/README.mdis the rendered output of values.yml, so it stayed at 2.0.12 while the source files moved to 3.0.0. The CI gate caught the drift.What
Immediate fix: regenerate
helm/README.mdto match the bumped values.yml. 4 lines change (Version badge + 3 image-tag rows in the values table).Future-proof: patch
.github/workflows/release-please.ymlwith aregen-helm-docsfollow-up job. It only runs when release-please opened or updated a PR (if: needs.release-please.outputs.pr != ''), checks out the PR branch, runsmake helm-docs, and pushes the regenerated README back to the same branch. From the next release onward, the release-please PR is self-consistent at open time.Test plan
make helm-docsproduces a clean diff (4 lines)make helm-docs-checkexits 0 after the regen