From 922e27fea7a2409f2a23a741b939ddfe01130324 Mon Sep 17 00:00:00 2001 From: Long Wu Yuan Date: Fri, 21 Jan 2022 05:02:30 +0530 Subject: [PATCH] reintroduce helm-docs step in ci (#8164) --- .github/workflows/ci.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 62843b1d7..63bc7da08 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -137,6 +137,17 @@ 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 + DIFF=$(git diff ${GITHUB_WORKSPACE}/charts/ingress-nginx/README.md) + if [ ! -z "$DIFF" ]; then + echo "Please use helm-docs in your clone, of your fork, of the project, and commit a updated README.md for the chart. https://github.com/kubernetes/ingress-nginx/blob/main/RELEASE.md#d-edit-the-valuesyaml-and-run-helm-docs" + fi + git diff --exit-code + rm -f ./helm-docs + - name: fix permissions run: | sudo mkdir -p $HOME/.kube