Skip to content

Commit 2fd1ff1

Browse files
ci: make the README drift hint runnable without a personal skill
The failure message pointed at $HOME/.claude/skills/helm-readme-generator, a personal Claude skill no other contributor has, so the log gave them nothing they could run. CI itself never used the skill — it calls the generator directly — so the hint now echoes that same npx command, interpolating README_GENERATOR_VERSION so the printed version cannot drift from the one CI enforces. CLAUDE.md documents the npx command as the route for the same reason, and notes that regenerating with a different generator version reflows the tables and fails the check.
1 parent 32884de commit 2fd1ff1

2 files changed

Lines changed: 15 additions & 10 deletions

File tree

.github/workflows/unit-tests.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ env:
1212
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
1313
# Pinned so a new plugin release cannot change test-suite parsing behaviour underneath CI.
1414
HELM_UNITTEST_VERSION: 0.8.0
15-
# Must match the version the helm-readme-generator skill uses, or the drift check below
16-
# will disagree with locally generated tables.
15+
# Pinned so a new generator release cannot reflow the tables underneath CI. Whatever you
16+
# regenerate with locally must use this same version or the drift check will disagree.
1717
README_GENERATOR_VERSION: 2.7.2
1818
# Pinned so a new ct release cannot introduce yamllint/yamale rules that fail CI on
1919
# unchanged charts. Bump deliberately, and re-run `ct lint --config ct.yaml` locally first.
@@ -109,8 +109,9 @@ jobs:
109109
done
110110
if ! git diff --exit-code -- 'charts/*/README.md'; then
111111
echo "::error::README parameter tables are out of date with values.yaml."
112-
echo "Regenerate them and commit the result:"
113-
echo ' SKILL_DIR="$HOME/.claude/skills/helm-readme-generator"'
114-
echo ' TABLE_ONLY=1 bash "$SKILL_DIR/scripts/bitnami-helm-readme.sh" charts/<chart>'
112+
echo "Regenerate them and commit the result, from the chart directory:"
113+
echo " cd charts/<chart>"
114+
echo " npx --yes @bitnami/readme-generator-for-helm@${README_GENERATOR_VERSION} -v values.yaml -r README.md"
115+
echo "This edits README.md in place, replacing only the generated parameter tables."
115116
exit 1
116117
fi

CLAUDE.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,19 @@ Current releases: `ontoserver` 0.5.0, `ontoserver-extras` 0.1.2, `ontoserver-ind
5555
## Editing a chart
5656

5757
- **The README parameter tables are generated, and CI fails if they drift from `values.yaml`.** Do not
58-
hand-write or hand-pad a row; add the `## @param` comment in `values.yaml` and regenerate:
58+
hand-write or hand-pad a row; add the `## @param` comment in `values.yaml` and regenerate with the
59+
same generator and version CI pins in `README_GENERATOR_VERSION`:
5960

6061
```sh
61-
SKILL_DIR="$HOME/.claude/skills/helm-readme-generator"
62-
TABLE_ONLY=1 bash "$SKILL_DIR/scripts/bitnami-helm-readme.sh" charts/<chart>
62+
cd charts/<chart>
63+
npx --yes @bitnami/readme-generator-for-helm@2.7.2 -v values.yaml -r README.md
6364
```
6465

65-
`TABLE_ONLY=1` rewrites only the tables and leaves hand-written prose sections alone. Expect it to
66-
reflow padding across the whole table, so commit it separately from the change it documents.
66+
It edits `README.md` in place and replaces only the generated tables, leaving hand-written prose
67+
sections alone. Expect it to reflow padding across the whole table, so commit it separately from the
68+
change it documents. A different version reflows differently and CI will reject it. (There is a
69+
`helm-readme-generator` skill wrapping this, but it is a personal skill other contributors do not
70+
have — keep the `npx` command as the documented route.)
6771
- **A new value needs four edits, not one:** `values.yaml` (with its `## @param` line), the matching
6872
`values.schema.json` entry (with an `enum` where the field is closed, which is what turns a typo
6973
into a render-time error), a `helm unittest` assertion on the rendered output, and the regenerated

0 commit comments

Comments
 (0)