[OPIK-7258] [GHA] fix: regenerate Helm chart README in release version-bump commit#7377
Open
JetoPistola wants to merge 1 commit into
Open
[OPIK-7258] [GHA] fix: regenerate Helm chart README in release version-bump commit#7377JetoPistola wants to merge 1 commit into
JetoPistola wants to merge 1 commit into
Conversation
Contributor
⏱️ pre-commit per-hook timing
⏭️ 39 skipped (no matching files changed)
|
…ion-bump commit The release workflow rewrites Chart.yaml version/appVersion and pushes to main, but never regenerated the helm-docs-derived README badges, so the README lagged one release. The next chart-touching PR then tripped the helm-docs / update_helm_readme.yaml gate over a stale badge. Regenerate the README with the same losisin/helm-docs-github-action used by update_helm_readme.yaml (git-push: false) right after the Chart.yaml bump and fold it into the existing version commit. Also clears the current drift already on main (README badge -> 2.1.18). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
57501ba to
46f49f9
Compare
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
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.
Details
The release workflow (
release.yaml, jobcommit-all-version-changes) already rewritesChart.yamlversion/appVersionand pushes tomain, but never regenerated the helm-docs-derivedREADME.mdbadges — so the chart README lagged one release behind. The staleness only surfaced when the next PR touchingdeployment/helm_chart/opik/**tripped thehelm-docspre-commit hook /update_helm_readme.yamlgate, forcing that author to bump the badge in unrelated work.losisin/helm-docs-github-action@v1(git-push: false) thatupdate_helm_readme.yamland the local pre-commit hook use, so CI and local stay in agreement.README.mdalongside the existing version files so it rides the same bot commit tomain— no separate PR, no drift window.2.1.17→2.1.18badge drift already present onmain.Change checklist
Issues
AI-WATERMARK
AI-WATERMARK: yes
Testing
docker run --rm -v "$PWD/deployment/helm_chart/opik:/helm-docs" jnorwood/helm-docs:v1.14.2 --chart-search-root=/helm-docs→ READMEVersion/AppVersionbadges updated2.1.17→2.1.18, diff limited to the two badge lines.pre-commit run actionlint --files .github/workflows/release.yaml→ Passed.Documentation
N/A — no user-facing documentation changes. The only doc touched is the auto-generated chart
README.mdbadge, which this change now maintains automatically.