Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (31 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) · 1.52 KB
Raw

Contributing

Workflow

  1. Commits follow Conventional Commits with the chart name as scope: feat(authup): ..., fix(authup): .... release-please derives the chart version and CHANGELOG from them — never edit Chart.yaml version, CHANGELOG.md or .release-please-manifest.json by hand.
  2. README.md per chart is GENERATED by helm-docs. Edit README.md.gotmpl and/or the # -- comments in values.yaml, then run make docs.
  3. values.schema.json is GENERATED by helm-schema from # @schema annotations in values.yaml. Run make schema.
  4. Before pushing: make test (lint + render every ci/*-values.yaml + values-coverage check). CI fails on generated-file drift.
  5. Breaking value changes: document the migration in BREAKING.md AND add a fail-loud tripwire for the old key in templates/validations.yaml.
  6. Update the artifacthub.io/changes annotation in Chart.yaml for user-visible changes.

One-time repository bootstrap

chart-releaser publishes the helm repo index onto the gh-pages branch and fails when the branch does not exist. Before the first release:

git switch --orphan gh-pages
git commit --allow-empty -m "chore: chart index"
git push origin gh-pages
git switch master

Then enable GitHub Pages for the gh-pages branch in the repo settings.

Local tooling

  • helm >= 3.14
  • docker (helm-docs / helm-schema run via pinned images through make)
  • optional: ct (chart-testing) and a kind cluster for install tests