Merge pull request #15 from spiffe/helm-docs-script

Move docs script to root of repo
This commit is contained in:
Faisal Memon
2023-02-17 09:55:57 -08:00
committed by GitHub
3 changed files with 3 additions and 3 deletions
+2 -2
View File
@@ -6,7 +6,7 @@ on:
paths:
- 'charts/**'
- '.github/workflows/helm-chart-ci.yml'
- '.github/scripts/*.sh'
- 'helm-docs.sh'
- '.github/kind/conf/kind-config.yaml'
concurrency:
@@ -27,7 +27,7 @@ jobs:
uses: actions/[email protected]
- name: Verify Docs updated
run: .github/scripts/helm-docs.sh
run: ./helm-docs.sh
lint-chart:
runs-on: ubuntu-22.04
+1 -1
View File
@@ -39,7 +39,7 @@ git rebase main
Any changes to Chart.yaml or values.yaml require an update of the README.md. This update can easily be generated using [helm-docs][].
```shell
helm-docs -g charts/«chart-name» -t .github/README.md.tmpl
./helm-docs.sh charts/«chart-name»
```
[helm-docs]: https://github.com/norwoodj/helm-docs "Generate documentation for your Helm chart."