feat: Support generating API docs #28
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Artifacts to OSS | |
| on: | |
| push: | |
| tags: | |
| - "v*.*.*" | |
| jobs: | |
| deploy-to-oss: | |
| runs-on: ubuntu-latest | |
| env: | |
| OSS_ENDPOINT: ${{ vars.OSS_ENDPOINT || 'oss-cn-hongkong.aliyuncs.com' }} | |
| OSS_REGION: ${{ vars.OSS_REGION || 'cn-hongkong' }} | |
| OSS_BUCKET: ${{ vars.OSS_BUCKET || 'higress-website-cn-hongkong' }} | |
| OSS_HELM_CHART_PATH: ${{ vars.OSS_HELM_CHART_PATH || '/helm-charts' }} | |
| OSS_API_DOCS_DIR_PATH: ${{ vars.OSS_API_DOCS_DIR_PATH || '/swagger/' }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Install Aliyun CLI | |
| run: | | |
| curl -O https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz | |
| tar -xzf aliyun-cli-linux-latest-amd64.tgz | |
| chmod +x aliyun | |
| ./aliyun version | |
| - name: Download Helm Charts Index | |
| run: ./aliyun oss cp oss://$OSS_BUCKET$OSS_HELM_CHART_PATH/index.yaml ./artifact/ -f -e $OSS_ENDPOINT --access-key-id ${{ secrets.ACCESS_KEYID }} --access-key-secret ${{ secrets.ACCESS_KEYSECRET }} --region $OSS_REGION | |
| - id: calc-version | |
| name: Calculate Version Number | |
| run: | | |
| version=$(echo ${{ github.ref_name }} | cut -c2-) | |
| echo "Version=$version" | |
| echo "version=$version" >> $GITHUB_OUTPUT | |
| - name: Build Artifact | |
| uses: stefanprodan/kube-tools@v1 | |
| with: | |
| helmv3: 3.7.2 | |
| command: | | |
| helmv3 package helm --debug --app-version ${{steps.calc-version.outputs.version}} --version ${{steps.calc-version.outputs.version}} -d ./artifact | |
| helmv3 repo index --url https://higress.io/helm-charts/ --merge ./artifact/index.yaml ./artifact | |
| cp ./artifact/index.yaml ./artifact/cn-index.yaml | |
| sed -i 's/higress\.io/higress\.cn/g' ./artifact/cn-index.yaml | |
| - name: Upload Helm Charts to OSS | |
| run: ./aliyun oss cp ./artifact/ oss://$OSS_BUCKET$OSS_HELM_CHART_PATH/ -r -f -e $OSS_ENDPOINT --access-key-id ${{ secrets.ACCESS_KEYID }} --access-key-secret ${{ secrets.ACCESS_KEYSECRET }} --region $OSS_REGION | |
| - name: "Setup Java" | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: 21 | |
| distribution: 'temurin' | |
| - name: "Setup Kind" | |
| uses: engineerd/setup-kind@v0.6.2 | |
| with: | |
| name: higress | |
| version: "v0.24.0" | |
| - name: Build Higress Console API Docs | |
| run: | | |
| helm repo add higress.io https://higress.cn/helm-charts | |
| helm install higress-console -n higress-system higress.io/higress-console \ | |
| --create-namespace --set global.local=true | |
| mvn clean verify -f ./backend/pom.xml -Papi-docs | |
| - name: Upload API Docs to OSS | |
| run: | | |
| ./aliyun oss cp ./backend/console/target/openapi.json oss://$OSS_BUCKET$OSS_API_DOCS_DIR_PATH -r -f -e $OSS_ENDPOINT --access-key-id ${{ secrets.ACCESS_KEYID }} --access-key-secret ${{ secrets.ACCESS_KEYSECRET }} --region $OSS_REGION | |
| ./aliyun oss cp ./backend/console/src/main/html/swagger/ oss://$OSS_BUCKET$OSS_API_DOCS_DIR_PATH -r -f -e $OSS_ENDPOINT --access-key-id ${{ secrets.ACCESS_KEYID }} --access-key-secret ${{ secrets.ACCESS_KEYSECRET }} --region $OSS_REGION |