panxiao81/helm-charts-hardened
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Migrate to readme-generator for helm maintained by bitnami (#431)

Browse Source 
Co-authored-by: Krishnakumar Venkataraman <[email protected]>
Co-authored-by: Marco Franssen <[email protected]>
This commit is contained in:
Krishna
2023-09-08 09:39:30 +02:00
committed by GitHub
co-authored by Krishnakumar Venkataraman Marco Franssen
parent dcc60a2896
commit 65d56957de
16 changed files with 1111 additions and 809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+3 -3
View File
@@ -48,14 +48,14 @@ Another approach to testing the chart is by installing one of the examples in yo
## Generating documentation
Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using [helm-docs][].
Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using [readme-generator](https://github.com/bitnami-labs/readme-generator-for-helm).
```shell
./helm-docs.sh charts/«chart-name»
./helm-docs.sh
```
## Bumping Chart version
In contrary to many other Helm repositories we do NOT require contributors to increate the Chart version. We have customized our release pipeline so we can bundle various PRs in a single release. Maintainers of the helm-charts in this repo will take care of the semantic versioning.
[helm-docs]: https://github.com/norwoodj/helm-docs "Generate documentation for your Helm chart."
[readme-generator]: https://github.com/bitnami-labs/readme-generator-for-helm "Auto generate READMEs for Helm Charts."