From 6f3baf7d8086e81ac99b56fb778c120f68bc7b16 Mon Sep 17 00:00:00 2001 From: Ruxandra Fediuc Date: Thu, 16 Jul 2026 11:56:22 -0700 Subject: [PATCH] ci(release): sync chart README to the gh-pages landing page 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. --- .github/workflows/release.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index dda9932..c9e53c5 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -9,7 +9,7 @@ name: Release Chart on: push: branches: [main] - paths: ['helm/Chart.yaml'] # fires on a chart version bump + paths: ['helm/Chart.yaml', 'helm/README.md'] # fires on a chart version bump or chart-README change workflow_dispatch: {} # manual re-publish of the current version permissions: @@ -46,6 +46,10 @@ jobs: git clone --branch gh-pages --single-branch \ git@github.com:socketdev-demo/socket-firewall-helm.git pages cp .deploy/*.tgz pages/ + # Keep the gh-pages landing page in sync with the chart README so the + # published values table never drifts from the chart (CE-238). The + # landing page renders README.md as its index. + cp helm/README.md pages/README.md # Re-index against the full gh-pages contents so all prior versions are # preserved; the published URL is unchanged. helm repo index pages --url https://socketdev-demo.github.io/socket-firewall-helm