diff --git a/README.md b/README.md index 88e3d41..0fab9fc 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,22 @@ helm install my-release onechart/onechart \ ``` See all [Examples](/examples/deploying-an-image) + +## Development + +Development of OneChart does not differ from developing a regular Helm chart. + +The source for OneChart is under `charts/onechart` where you can locate the `Chart.yaml`, `values.yaml` and the templates. + +We write unit tests for our helm charts. Pull requests are only accepted with proper test coverage. + +The tests are located under `charts/onechart/test` and use the https://github.com/DataDog/helm-unittest.git Helm plugin to run the tests. + +For installation, refer to the CI workflow at `.github/workflows/build.yaml` +TODO: move it to the Makefile + +## Release + +`make all` to test and package the Helm chart. +The chart archives are put under `docs/` together with the Helm repository manifest (index.yaml) +It is then served with Github Pages on https://chart.onechart.dev