merge release/v0.3.0 to main (#660)

Signed-off-by: spacewander <spacewanderlzx@gmail.com>
mosn · Jul 30, 2024 · a0ac647 · a0ac647
1 parent bb415ab
commit a0ac647
Show file tree

Hide file tree

Showing 27 changed files with 104 additions and 63 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -2,9 +2,9 @@ name: lint
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "release/**" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "release/**" ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_number || github.ref }}

diff --git a/.github/workflows/release-branch.yml b/.github/workflows/release-branch.yml
@@ -21,11 +21,11 @@ jobs:
       with:
         go-version: '1.21'
         cache-dependency-path: "**/*.sum"
-    - name: Check helm docs
+    - name: Check helm files
       run: |
-        make gen-helm-docs
+        make gen-helm
         if ! git diff --exit-code; then
-          echo "Generated files are not up-to-date. Please run 'make gen-helm-docs' and commit changes."
+          echo "Generated files are not up-to-date. Please run 'make gen-helm' and commit changes."
           exit 1
         fi
 
@@ -45,6 +45,11 @@ jobs:
           helm dependency list $dir 2> /dev/null | tail +2 | head -n -1 | awk '{ print "helm repo add " $1 " " $3 }' | while read cmd; do $cmd; done
         done
 
+    - name: Smoking test
+      working-directory: ./e2e
+      run: |
+        make create-cluster deploy-istio-to-verify-helm-install
+
     - name: Run chart-releaser
       uses: helm/chart-releaser-action@v1.6.0
       with:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,12 +2,12 @@ name: test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "release/**" ]
     paths-ignore:
     - "site/**"
     - "**/*.md"
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "release/**" ]
     paths-ignore:
     - "site/**"
     - "**/*.md"

diff --git a/MAINTAIN.md b/MAINTAIN.md
@@ -4,12 +4,17 @@ This doc tracks how to maintain the source code of HTNN.
 
 To release a new version, please follow the steps below:
 
-* Create a new release branch `release/v${version}` from the main branch.
-* Create tag `api/v${version}`, then update the `go.mod` which depend on `mosn.io/htnn/api`.
-* Do the same things with `types`, `controller` and `plugins`.
-* Remove the `go.work` file.
-* Update the version in the `manifests/charts/*/Chart.yaml`.
-(TBD)
+1. Create a new release branch `release/v${version}` from the main branch. Do the work below on the new branch.
+2. Create tag `api/v${version}`.
+3. Commit the changes below (the CI will fail at this point):
+    * Update those `go.mod` which depend on `mosn.io/htnn/$mod`.
+4. Create tag `types/v${version}` for `types` module. Then do the same with `controller` and `plugins`. Rerun the `test` workflow to verify the changes. Don't panic for "server response: not found" error. The sync of sum.golang.org might take half an hour. Try again later.
+5. Create tag `image/v${version}` to trigger image building.
+6. Submit a new commit with the changes below:
+    * Once the image is ready, update the version in the `manifests/charts/*/Chart.yaml`.
+    * Run `make fmt-go`.
+7. The CI will create a new chart package.
+8. Merge the release branch to the main branch.
 
 ## Upgrade components
 

diff --git a/Makefile b/Makefile
@@ -185,7 +185,7 @@ lint-website: $(LOCALBIN)
 .PHONY: lint-remain
 lint-remain:
 	grep '>>>>>>' $(shell git ls-files .) | grep -v 'Makefile:' && exit 1 || true
-	go run tools/cmd/linter/main.go
+	cd tools && go run cmd/linter/main.go
 
 .PHONY: lint
 lint: lint-go lint-proto lint-license lint-spell lint-editorconfig lint-cjk lint-remain

diff --git a/controller/go.mod b/controller/go.mod
@@ -42,8 +42,8 @@ require (
 	k8s.io/api v0.29.3
 	k8s.io/apimachinery v0.29.3
 	k8s.io/client-go v0.29.3
-	mosn.io/htnn/api v0.3.0
-	mosn.io/htnn/types v0.3.0
+	mosn.io/htnn/api v0.3.1
+	mosn.io/htnn/types v0.3.1
 	sigs.k8s.io/controller-runtime v0.17.3
 	sigs.k8s.io/gateway-api v1.0.0
 	sigs.k8s.io/yaml v1.4.0

diff --git a/controller/go.sum b/controller/go.sum
@@ -569,10 +569,10 @@ k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00 h1:aVUu9fTY98ivBPKR9Y5w/A
 k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00/go.mod h1:AsvuZPBlUDVuCdzJ87iajxtXuR9oktsTctW/R9wwouA=
 k8s.io/utils v0.0.0-20230726121419-3b25d923346b h1:sgn3ZU783SCgtaSJjpcVVlRqd6GSnlTLKgpAAttJvpI=
 k8s.io/utils v0.0.0-20230726121419-3b25d923346b/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
-mosn.io/htnn/api v0.3.0 h1:wAkMJrLcHKzam+41Twp02NRn84eNBERMVx5WTnWH2EY=
-mosn.io/htnn/api v0.3.0/go.mod h1:DumqbmMou8J1/DzEDaRIZWpan82bOqxGceWxTju7WkU=
-mosn.io/htnn/types v0.3.0 h1:HIajVzpr3KkWD1kXSHcCr7497DoOcKOGN7592ph/SyY=
-mosn.io/htnn/types v0.3.0/go.mod h1:9wCJE4V+QgFDtCpY6rtdKy9xh/FPFfAH+GkTGRviaoY=
+mosn.io/htnn/api v0.3.1 h1:vQMJI1XCgrWb3PdK7/T9ygdytl1Fps43Ekj36OY1vRk=
+mosn.io/htnn/api v0.3.1/go.mod h1:DumqbmMou8J1/DzEDaRIZWpan82bOqxGceWxTju7WkU=
+mosn.io/htnn/types v0.3.1 h1:WTxSVe8yUQhIjnYs6Y5RkPBUfknM2FBzgMdCzDfqjbQ=
+mosn.io/htnn/types v0.3.1/go.mod h1:SEEwBojLXw7tEgmEro3cqxgUFWuJRsBosTU86U5S92A=
 sigs.k8s.io/controller-runtime v0.17.3 h1:65QmN7r3FWgTxDMz9fvGnO1kbf2nu+acg9p2R9oYYYk=
 sigs.k8s.io/controller-runtime v0.17.3/go.mod h1:N0jpP5Lo7lMTF9aL56Z/B2oWBJjey6StQM0jRbKQXtY=
 sigs.k8s.io/gateway-api v1.0.0 h1:iPTStSv41+d9p0xFydll6d7f7MOBGuqXM6p2/zVYMAs=

diff --git a/e2e/Makefile b/e2e/Makefile
@@ -58,6 +58,10 @@ e2e-prepare-data-plane-image: kind
 deploy-istio: helm
 	ISTIO_VERSION=$(ISTIO_VERSION) LOCALBIN=$(LOCALBIN) ./istio.sh install
 
+.PHONY: deploy-istio-to-verify-helm-install
+deploy-istio-to-verify-helm-install: helm
+	ISTIO_VERSION=$(ISTIO_VERSION) LOCALBIN=$(LOCALBIN) ./istio.sh installWithoutOptions
+
 .PHONY: run-e2e
 run-e2e:
 	PATH=$(LOCALBIN):"$(PATH)" go test -v ./... || (bash -x ./collect_e2e_logs.sh; exit -1)

diff --git a/e2e/go.mod b/e2e/go.mod
@@ -22,8 +22,8 @@ require (
 	k8s.io/api v0.29.3
 	k8s.io/apimachinery v0.29.3
 	k8s.io/client-go v0.29.3
-	mosn.io/htnn/controller v0.3.0
-	mosn.io/htnn/types v0.3.0
+	mosn.io/htnn/controller v0.3.1
+	mosn.io/htnn/types v0.3.1
 	sigs.k8s.io/controller-runtime v0.17.3
 	sigs.k8s.io/gateway-api v1.0.0
 )
@@ -71,7 +71,7 @@ require (
 	k8s.io/klog/v2 v2.110.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00 // indirect
 	k8s.io/utils v0.0.0-20230726121419-3b25d923346b // indirect
-	mosn.io/htnn/api v0.3.0 // indirect
+	mosn.io/htnn/api v0.3.1 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect

diff --git a/e2e/go.sum b/e2e/go.sum
@@ -258,12 +258,12 @@ k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00 h1:aVUu9fTY98ivBPKR9Y5w/A
 k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00/go.mod h1:AsvuZPBlUDVuCdzJ87iajxtXuR9oktsTctW/R9wwouA=
 k8s.io/utils v0.0.0-20230726121419-3b25d923346b h1:sgn3ZU783SCgtaSJjpcVVlRqd6GSnlTLKgpAAttJvpI=
 k8s.io/utils v0.0.0-20230726121419-3b25d923346b/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
-mosn.io/htnn/api v0.3.0 h1:wAkMJrLcHKzam+41Twp02NRn84eNBERMVx5WTnWH2EY=
-mosn.io/htnn/api v0.3.0/go.mod h1:DumqbmMou8J1/DzEDaRIZWpan82bOqxGceWxTju7WkU=
-mosn.io/htnn/controller v0.3.0 h1:ntdxIfIodQTZ3V+5kwpxNrzVcxrQ8DeZWXAVt1nFdXI=
-mosn.io/htnn/controller v0.3.0/go.mod h1:sKce6I7GEGT6wpje4fvfaWrE/u/iJE76sUTcSd0uEaw=
-mosn.io/htnn/types v0.3.0 h1:HIajVzpr3KkWD1kXSHcCr7497DoOcKOGN7592ph/SyY=
-mosn.io/htnn/types v0.3.0/go.mod h1:9wCJE4V+QgFDtCpY6rtdKy9xh/FPFfAH+GkTGRviaoY=
+mosn.io/htnn/api v0.3.1 h1:vQMJI1XCgrWb3PdK7/T9ygdytl1Fps43Ekj36OY1vRk=
+mosn.io/htnn/api v0.3.1/go.mod h1:DumqbmMou8J1/DzEDaRIZWpan82bOqxGceWxTju7WkU=
+mosn.io/htnn/controller v0.3.1 h1:hLT7+SWdRpeQ+0yyiTuzDaPDp6ZXy4WE3TfqGxbkB2A=
+mosn.io/htnn/controller v0.3.1/go.mod h1:U54nzBvGbU+Pu/vwb7hvha5JNSj1NF8wWgx1aVzvUpg=
+mosn.io/htnn/types v0.3.1 h1:WTxSVe8yUQhIjnYs6Y5RkPBUfknM2FBzgMdCzDfqjbQ=
+mosn.io/htnn/types v0.3.1/go.mod h1:SEEwBojLXw7tEgmEro3cqxgUFWuJRsBosTU86U5S92A=
 sigs.k8s.io/controller-runtime v0.17.3 h1:65QmN7r3FWgTxDMz9fvGnO1kbf2nu+acg9p2R9oYYYk=
 sigs.k8s.io/controller-runtime v0.17.3/go.mod h1:N0jpP5Lo7lMTF9aL56Z/B2oWBJjey6StQM0jRbKQXtY=
 sigs.k8s.io/gateway-api v1.0.0 h1:iPTStSv41+d9p0xFydll6d7f7MOBGuqXM6p2/zVYMAs=

diff --git a/e2e/istio.sh b/e2e/istio.sh
@@ -21,24 +21,39 @@ HELM="${LOCALBIN}/helm"
 E2E_DIR="$(pwd)"
 
 install() {
+    OPTIONS_DISABLED="$1"
+
     pushd ../manifests/charts
 
     $HELM dependency update htnn-controller
     $HELM dependency update htnn-gateway
     $HELM package htnn-controller htnn-controller
     $HELM package htnn-gateway htnn-gateway
 
-    $HELM install htnn-controller htnn-controller --namespace istio-system --create-namespace --wait -f "$E2E_DIR/htnn_controller_values.yaml" \
+    CONTROLLER_VALUES_OPT="-f $E2E_DIR/htnn_controller_values.yaml"
+    GATEWAY_VALUES_OPT="-f $E2E_DIR/htnn_gateway_values.yaml"
+    if [ -n "$OPTIONS_DISABLED" ]; then
+        CONTROLLER_VALUES_OPT=
+        GATEWAY_VALUES_OPT=
+    fi
+
+    # shellcheck disable=SC2086
+    $HELM install htnn-controller htnn-controller --namespace istio-system --create-namespace --wait $CONTROLLER_VALUES_OPT \
         || exitWithAnalysis
 
-    $HELM install htnn-gateway htnn-gateway --namespace istio-system --create-namespace -f "$E2E_DIR/htnn_gateway_values.yaml" \
+    # shellcheck disable=SC2086
+    $HELM install htnn-gateway htnn-gateway --namespace istio-system --create-namespace $GATEWAY_VALUES_OPT \
         && \
         (kubectl wait --timeout=5m -n istio-system deployment/istio-ingressgateway --for=condition=Available \
         || exitWithAnalysis)
 
     popd
 }
 
+installWithoutOptions() {
+    install WithoutOptions
+}
+
 exitWithAnalysis() {
     kubectl get pods -n istio-system -o yaml
     for pod in $(kubectl get pods -n istio-system | grep 'istiod-' | awk '{print $1}'); do

diff --git a/manifests/charts/htnn-controller/Chart.yaml b/manifests/charts/htnn-controller/Chart.yaml
@@ -12,13 +12,13 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.5
+version: 0.2.2
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.2.1"
+appVersion: "0.3.1"
 
 dependencies:
   - name: base

diff --git a/manifests/charts/htnn-controller/README.md b/manifests/charts/htnn-controller/README.md
@@ -1,6 +1,6 @@
 # htnn-controller
 
-![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.1](https://img.shields.io/badge/AppVersion-0.2.1-informational?style=flat-square)
+![Version: 0.2.2](https://img.shields.io/badge/Version-0.2.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.1](https://img.shields.io/badge/AppVersion-0.3.1-informational?style=flat-square)
 
 A Helm chart for HTNN controller
 
@@ -100,7 +100,7 @@ helm uninstall htnn-controller -n istio-system
 | global.remotePilotAddress | string | `""` |  |
 | global.sds.token.aud | string | `"istio-ca"` |  |
 | global.sts.servicePort | int | `0` |  |
-| global.tag | string | `"dev"` |  |
+| global.tag | string | `"v0.3.1"` |  |
 | istio_cni.chained | bool | `true` |  |
 | istio_cni.provider | string | `"default"` |  |
 | istiodRemote.injectionCABundle | string | `""` |  |

diff --git a/manifests/charts/htnn-controller/values.schema.json b/manifests/charts/htnn-controller/values.schema.json
@@ -532,8 +532,7 @@
           ]
         },
         "tag": {
-          "default": "dev",
-          "description": "FIXME: use the released image once we have a release",
+          "default": "v0.3.1",
           "title": "tag",
           "type": "string"
         }

diff --git a/manifests/charts/htnn-controller/values.yaml b/manifests/charts/htnn-controller/values.yaml
@@ -239,8 +239,7 @@ global:
 
   # Default hub for HTNN images.
   hub: ghcr.io/mosn
-  # FIXME: use the released image once we have a release
-  tag: dev
+  tag: v0.3.1
 
   # Specify image pull policy if default behavior isn't desired.
   # Default behavior: latest images will be Always else IfNotPresent.

diff --git a/manifests/charts/htnn-gateway/Chart.yaml b/manifests/charts/htnn-gateway/Chart.yaml
@@ -12,13 +12,13 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.4
+version: 0.2.1
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.2.1"
+appVersion: "0.3.1"
 
 dependencies:
   # istio gateway depends on istiod to inject the image, so we need to install the istiod first.

diff --git a/manifests/charts/htnn-gateway/README.md b/manifests/charts/htnn-gateway/README.md
@@ -1,6 +1,6 @@
 # htnn-gateway
 
-![Version: 0.1.4](https://img.shields.io/badge/Version-0.1.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.1](https://img.shields.io/badge/AppVersion-0.2.1-informational?style=flat-square)
+![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.1](https://img.shields.io/badge/AppVersion-0.3.1-informational?style=flat-square)
 
 A Helm chart for HTNN data plane running as gateway
 

diff --git a/manifests/images/cp/Dockerfile b/manifests/images/cp/Dockerfile
@@ -26,7 +26,7 @@ WORKDIR /workspace
 # Copy the source
 
 COPY go.* ./
-RUN sed -i 's/.\/site/.\/external\/istio/' go.work && sed -i '/.\/e2e/d' go.work && sed -i '/.\/tools/d' go.work # remove this in release
+RUN sed -i 's/.\/site/.\/external\/istio/' go.work && sed -i '/.\/e2e/d' go.work && sed -i '/.\/tools/d' go.work
 # use single layer to copy only works on files, so we have to list all the directories
 COPY api/ api/
 COPY types/ types/

diff --git a/manifests/images/dp/Dockerfile b/manifests/images/dp/Dockerfile
@@ -26,7 +26,7 @@ WORKDIR /workspace
 # Copy the source
 
 COPY go.* ./
-RUN sed -i 's/.\/site/.\/external\/istio/' go.work && sed -i '/.\/e2e/d' go.work && sed -i '/.\/tools/d' go.work # remove this in release
+RUN sed -i 's/.\/site/.\/external\/istio/' go.work && sed -i '/.\/e2e/d' go.work && sed -i '/.\/tools/d' go.work
 COPY api/ api/
 COPY types/ types/
 COPY plugins/ plugins/

diff --git a/plugins/go.mod b/plugins/go.mod
@@ -37,8 +37,8 @@ require (
 	golang.org/x/oauth2 v0.20.0
 	golang.org/x/time v0.5.0
 	google.golang.org/protobuf v1.34.0
-	mosn.io/htnn/api v0.3.0
-	mosn.io/htnn/types v0.3.0
+	mosn.io/htnn/api v0.3.1
+	mosn.io/htnn/types v0.3.1
 )
 
 require (

diff --git a/plugins/go.sum b/plugins/go.sum
@@ -247,9 +247,9 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-mosn.io/htnn/api v0.3.0 h1:wAkMJrLcHKzam+41Twp02NRn84eNBERMVx5WTnWH2EY=
-mosn.io/htnn/api v0.3.0/go.mod h1:DumqbmMou8J1/DzEDaRIZWpan82bOqxGceWxTju7WkU=
-mosn.io/htnn/types v0.3.0 h1:HIajVzpr3KkWD1kXSHcCr7497DoOcKOGN7592ph/SyY=
-mosn.io/htnn/types v0.3.0/go.mod h1:9wCJE4V+QgFDtCpY6rtdKy9xh/FPFfAH+GkTGRviaoY=
+mosn.io/htnn/api v0.3.1 h1:vQMJI1XCgrWb3PdK7/T9ygdytl1Fps43Ekj36OY1vRk=
+mosn.io/htnn/api v0.3.1/go.mod h1:DumqbmMou8J1/DzEDaRIZWpan82bOqxGceWxTju7WkU=
+mosn.io/htnn/types v0.3.1 h1:WTxSVe8yUQhIjnYs6Y5RkPBUfknM2FBzgMdCzDfqjbQ=
+mosn.io/htnn/types v0.3.1/go.mod h1:SEEwBojLXw7tEgmEro3cqxgUFWuJRsBosTU86U5S92A=
 sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=
 sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=
diff --git a/site/content/en/docs/getting-started/quick_start.md b/site/content/en/docs/getting-started/quick_start.md
@@ -10,12 +10,17 @@ title: Quick Start
 
 ```shell
 helm repo add htnn https://mosn.github.io/htnn
-helm repo update
 ```
 
 ## Installing HTNN
 
-1. Install the control plane component:
+1. Update the repository information to get the latest version:
+
+```shell
+helm repo update
+```
+
+2. Install the control plane component:
 
 ```shell
 $ helm install htnn-controller htnn/htnn-controller --namespace istio-system --create-namespace --debug --wait
@@ -28,7 +33,7 @@ REVISION: 1
 TEST SUITE: None
 ```
 
-2. Install the data plane component:
+3. Install the data plane component:
 
 ```shell
 $ helm install htnn-gateway htnn/htnn-gateway --namespace istio-system --create-namespace && \

diff --git a/site/content/zh-hans/docs/getting-started/quick_start.md b/site/content/zh-hans/docs/getting-started/quick_start.md
@@ -10,14 +10,19 @@ title: 快速上手
 
 ```shell
 helm repo add htnn https://mosn.github.io/htnn
-helm repo update
 ```
 
 ## 安装 HTNN
 
 让我们把 HTNN 安装到 `istio-system` namespace 中。为了简单起见，HTNN 和其他用于 demo 的资源都会安装到该 namespace。
 
-1. 安装控制面组件：
+1. 更新仓库信息以获取最新的版本：
+
+```shell
+helm repo update
+```
+
+2. 安装控制面组件：
 
 ```shell
 $ helm install htnn-controller htnn/htnn-controller \
@@ -32,7 +37,7 @@ REVISION: 1
 TEST SUITE: None
 ```
 
-2. 安装数据面组件：
+3. 安装数据面组件：
 
 ```shell
 $ helm install htnn-gateway htnn/htnn-gateway --namespace istio-system --create-namespace && \

diff --git a/tools/cmd/linter/main.go b/tools/cmd/linter/main.go
@@ -508,6 +508,9 @@ func lintConfigurationByCategory(category string) error {
 }
 
 func main() {
+	// change to the root directory so that we don't need to worry about why this tool locates
+	os.Chdir("..")
+
 	type linter func() error
 	linters := []linter{
 		lintConfiguration,