chore(charts): add helm-docs CI to auto-generate chart READMEs#1259
chore(charts): add helm-docs CI to auto-generate chart READMEs#1259ferponse wants to merge 3 commits into
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 171674fa88
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Co-authored-by: Atenea Agent <svc_atenea_gitlab@ofidona.net>
Resolve README conflicts in the opensandbox-controller and opensandbox-server charts by regenerating them with helm-docs against the merged chart values (the source of truth), instead of hand-merging generated output. Also refreshes the umbrella opensandbox chart README so all three match helm-docs output. Co-authored-by: Atenea Agent <svc_atenea_gitlab@ofidona.net>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dafc333b6c
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - name: Install helm-docs | ||
| run: | | ||
| wget -qO /tmp/helm-docs.tar.gz \ | ||
| https://github.com/norwoodj/helm-docs/releases/latest/download/helm-docs_Linux_x86_64.tar.gz |
There was a problem hiding this comment.
This download URL does not match the assets published by norwoodj/helm-docs: the latest release assets are versioned, e.g. helm-docs_1.14.2_Linux_x86_64.tar.gz, not helm-docs_Linux_x86_64.tar.gz. As a result, every chart PR will fail in the install step before helm-docs can run; pin a version in the filename or resolve the latest asset name dynamically.
Useful? React with 👍 / 👎.
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.head_ref }} |
There was a problem hiding this comment.
For fork PRs this checkout still defaults repository to the base repo while github.head_ref is only the contributor fork's branch name, so a branch name that does not also exist in the base repo fails checkout before the verify-only fork step can run. Fresh evidence beyond the prior thread: the fork guard starts only later in this workflow, after this unconditional checkout; use the PR head repo for fork checkouts or avoid overriding ref on fork PRs.
Useful? React with 👍 / 👎.
1 participant
Summary
The chart
values.yamlfiles already follow thehelm-docscomment convention (# --prefix on field descriptions), buthelm-docsis not run in CI. This means chart READMEs are either missing or manually maintained and can drift from the actual values.Closes #1253
Changes
.github/workflows/helm-docs.yml— triggers on PRs that touchvalues.yamlorChart.yaml, regenerates READMEs and auto-commits themREADME.mdfor all three charts (opensandbox-controller,opensandbox-server,opensandbox)How it works
helm-docsreadsChart.yamlfor metadata and the# --annotations invalues.yamlto produce a Markdown table of all values. Since the charts already use this convention, no changes tovalues.yamlare needed — this works immediately.Example of an existing annotation that gets picked up:
Notes
stefanzweifel/git-auto-commit-actionaction is widely used for this pattern.