docs(charts): using helm-docs for chart (#8061)

This enables the use of the `helm-docs` tool on the Helm chart located in `charts/ingress-nginx`. This will make it possible to automatically document new variables in the `values.yaml` file.

Signed-off-by: Scott Crooks <scott.crooks@gmail.com>
This commit is contained in:
Scott Crooks 2022-01-08 11:53:04 +01:00 committed by GitHub
parent e625c2507a
commit 71de8e1a23
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 670 additions and 172 deletions

View file

@ -123,6 +123,11 @@ jobs:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Go
uses: actions/setup-go@v2
with:
go-version: '^1.17'
- name: cache
uses: actions/download-artifact@v2
with:
@ -132,6 +137,13 @@ jobs:
run: |
./build/run-in-docker.sh ./hack/verify-chart-lint.sh
- name: Run helm-docs
run: |
GOBIN=$PWD GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.6.0
./helm-docs --chart-search-root=${GITHUB_WORKSPACE}/charts
git diff --exit-code
rm -f ./helm-docs
- name: fix permissions
run: |
sudo mkdir -p $HOME/.kube