ci(release): sync chart README to the gh-pages landing page - #17
Merged
Conversation
The release workflow published the chart tarball and re-indexed gh-pages, but never updated README.md on the gh-pages branch. GitHub Pages renders that README as the landing page, so its values table was a frozen snapshot that drifted from the chart every release (e.g. missing the metrics and bearer-token values). Copy helm/README.md onto the gh-pages root on each publish, and also trigger on helm/README.md changes so doc-only edits propagate without a version bump. Tracks CE-238.
Ruxandra Fediuc (ruxandrafed)
requested review from
Douglas (dacoburn),
Eric Hibbs (flowstate) and
Phil Gran (philgran)
July 16, 2026 18:57
Eric Hibbs (flowstate)
approved these changes
Jul 17, 2026
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
2 participants
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.
Problem
The landing page at https://socketdev-demo.github.io/socket-firewall-helm/ renders
README.mdfrom the gh-pages branch. The release workflow publishes the chart tarball and re-indexesindex.yaml, but never updates thatREADME.md— so the landing page is a frozen snapshot that drifts from the chart on every release.Observed: the published values table is missing recently-added values (e.g.
metrics.*from #14 / 0.7.0, andsocket.bearerTokenfrom #16 / 0.8.0). The chart's own README (inside the.tgz, and onhelm show readme) is correct — only the landing page is stale.Fix
cp helm/README.md pages/README.mdbefore re-index/commit → the landing page always reflects the current chart README.helm/README.mdto the workflowpathstrigger → doc-only edits publish without needing aChart.yamlversion bump.Next publish overwrites the stale landing page with the current README (bearer + metrics rows included) and it never drifts again. Tracks CE-238.
Notes
index.yamlare produced.[values.yaml](values.yaml)) resolve inside the chart but not at the gh-pages root — cosmetic; can follow up if we want absolute links on the landing page.