[GitHub] [apisix-helm-chart] tokers commented on a diff in pull request #415: chore use helm docs to generate documentation

[GitBox <gi...@apache.org>]

tokers commented on code in PR #415:
URL: https://github.com/apache/apisix-helm-chart/pull/415#discussion_r1048232504


##########
.github/workflows/ci.yaml:
##########
@@ -68,3 +68,20 @@ jobs:
                && helm repo add apisix https://charts.apiseven.com \
                && ct install \
                   --charts charts/apisix'
+
+      - name: Setup Go

Review Comment:
   Let's add a Makefile directive for running the helm-docs, so that the complexity can be reduced.



##########
.github/workflows/ci.yaml:
##########
@@ -68,3 +68,20 @@ jobs:
                && helm repo add apisix https://charts.apiseven.com \
                && ct install \
                   --charts charts/apisix'
+
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.19.2'
+
+      - name: Run helm-docs
+        run: |
+          GOBIN=$PWD GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.11.0
+          ./helm-docs --chart-search-root=${GITHUB_WORKSPACE}/charts
+          DIFF=$(git diff ${GITHUB_WORKSPACE}/charts/**/*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
+          

Review Comment:
   Please add the EOL symbol.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org