shreemaan-abhishek commented on code in PR #733:
URL: https://github.com/apache/apisix-helm-chart/pull/733#discussion_r1529640693
##########
.github/workflows/ci.yaml:
##########
@@ -94,3 +69,18 @@ jobs:
&& 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/[email protected]
+ ./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."
+ fi
+ git diff --exit-code
+ rm -f ./helm-docs
Review Comment:
```suggestion
rm -f ./helm-docs
```
##########
README.md:
##########
@@ -31,5 +31,10 @@ Currently, APISIX Ingress Controller automatically
manipulates some APISIX resou
| | APISIX | APISIX Ingress | APISIX Dashboard |
| :--------: | :----: | :------------: | :--------------: |
+| Chart v2.x | v3.x | v1.x | v3.x |
| Chart v1.x | v3.x | v1.x | v3.x |
| Chart v0.x | v2.x | v1.x | v2.x |
+
+## Changelogs
+
+We have made numerous broken changes to the APISIX Helm chart between v1.x and
v2.x. If you wish to continue using or updating the v1.x, please utilize the
`apisix/1.x` branch available in the repository.
Review Comment:
```suggestion
We have made numerous breaking changes to the APISIX Helm chart between v1.x
and v2.x. If you wish to continue using or updating the v1.x, please utilize
the `apisix/1.x` branch available in the repository.
```
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
