panxiao81/helm-charts-hardened
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
helm-charts-hardened/AGENTS.md
T
Faisal Memon 9273f11f0a Support root-level spire-lib chart reuse (#785) 
* Add root-level spire-lib chart

Signed-off-by: Faisal Memon <[email protected]>

* Make spire consume root-level spire-lib

Signed-off-by: Faisal Memon <[email protected]>

* Prepare chart dependencies in CI

Signed-off-by: Faisal Memon <[email protected]>

* Document DCO requirement in CODEX

Signed-off-by: Faisal Memon <[email protected]>

* Centralize local chart dependency prep

Signed-off-by: Faisal Memon <[email protected]>

* Exclude spire-lib from chart-testing install

Signed-off-by: Faisal Memon <[email protected]>

* Rename CODEX guide to AGENTS

Signed-off-by: Faisal Memon <[email protected]>

* Add make target for chart dependencies

Signed-off-by: Faisal Memon <[email protected]>

---------

Signed-off-by: Faisal Memon <[email protected]>
2026-04-09 05:14:05 -07:00

2.2 KiB
Raw Permalink Blame History

AGENTS

This file is a lightweight working guide for Codex and human contributors in this repository.

Repo Overview

  • Main charts live in charts/
  • The integrated SPIRE chart is charts/spire
  • Supporting charts include charts/spire-crds, charts/spire-ha-agent, charts/spiffe-step-ssh, and subcharts under charts/spire/charts/
  • Example installs and scenario configs live in examples/
  • Go-based unit tests live in tests/unit
  • Cluster-backed integration tests live in tests/integration

Common Commands

  • make lint
    • Runs chart-testing lint using ct.yaml
  • cd tests/unit && ginkgo
    • Runs Go unit/render tests for Helm templates
  • make test
    • Runs chart tests and example tests against a dedicated Kubernetes cluster
  • ./helm-docs.sh
    • Regenerates chart README files after Chart.yaml or values.yaml changes

Working Agreements

  • Do not bump chart versions as part of normal contributions; maintainers handle release versioning
  • If you change Chart.yaml or values.yaml, regenerate docs with ./helm-docs.sh
  • Prefer focused changes to a single chart or feature area per branch
  • Preserve existing Helm templating patterns and values structure unless the task requires a broader refactor
  • When possible, validate template changes with cd tests/unit && ginkgo before broader cluster tests
  • PR commits should include a Signed-off-by: trailer to satisfy the repository's DCO check
  • If DCO fails after commits are already pushed, fix it by rewriting the affected commits with signoff and force-pushing the branch

Testing Notes

  • make test assumes access to a dedicated Kubernetes cluster
  • CI also runs Kind-based install tests and example matrices from .github/workflows/helm-chart-ci.yaml
  • Unit tests render the charts/spire chart directly and assert against generated template output

Useful Paths

  • README.md
  • CONTRIBUTING.md
  • .github/workflows/helm-chart-ci.yaml
  • ct.yaml
  • charts/spire/
  • tests/unit/spire_test.go

Editing Guidance

  • Keep generated README sections in sync by rerunning ./helm-docs.sh
  • Avoid hardcoded image references in templates; CI checks for overridable image templating
  • Be careful with changes that affect nested charts, examples, or appVersion alignment across subcharts
Reference in New Issue View Git Blame Copy Permalink