Skip to content

docs(helm): add chart readme generation#1437

Merged
TaylorMutch merged 1 commit into
mainfrom
tmutch/helm-readme-docs-gen
May 18, 2026
Merged

docs(helm): add chart readme generation#1437
TaylorMutch merged 1 commit into
mainfrom
tmutch/helm-readme-docs-gen

Conversation

@TaylorMutch
Copy link
Copy Markdown
Collaborator

Summary

Add helm-docs-based generation for the OpenShell Helm chart README and enforce that the generated README stays in sync. This keeps the chart README's useful installation guidance while adding generated values documentation from values.yaml.

Related Issue

None.

Changes

  • Added pinned helm-docs tooling to mise and the lockfile.
  • Added helm:docs and helm:docs:check tasks for generation and sync verification.
  • Added a README.md.gotmpl template and generated Helm values documentation.
  • Wired pre-commit linting and the Helm Lint workflow to check generated docs after Helm lint.
  • Documented the new task and ensured the CI image picks up helm-docs through mise install --locked.

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
@github-actions
Copy link
Copy Markdown

@TaylorMutch TaylorMutch merged commit a7cd160 into main May 18, 2026
28 checks passed
@TaylorMutch TaylorMutch deleted the tmutch/helm-readme-docs-gen branch May 18, 2026 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants