proofread api-v3.1 #34
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 API documentation | |
| permissions: | |
| contents: read | |
| on: | |
| workflow_dispatch: | |
| release: | |
| types: [published] | |
| push: | |
| branches: | |
| - chore/update-techdoc | |
| jobs: | |
| deploy-doc: | |
| name: Deploy | |
| runs-on: ubuntu-latest | |
| # add files here | |
| strategy: | |
| matrix: | |
| include: | |
| - doc: api | |
| version: v3.1 | |
| token: BUMP_TOKEN_API | |
| - doc: api | |
| version: v3.0 | |
| token: BUMP_TOKEN_API | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Verify OpenAPI files | |
| run: | | |
| file="api/specs/${{ matrix.doc }}-${{ matrix.version }}.yaml" | |
| if [ ! -f "$file" ]; then | |
| echo "Error: $file does not exist" | |
| exit 1 | |
| fi | |
| - name: Validate OpenAPI syntax | |
| uses: swaggerexpert/swagger-editor-validate@v1 | |
| with: | |
| definition-file: api/specs/${{ matrix.doc }}-${{ matrix.version }}.yaml | |
| - name: Deploy | |
| uses: bump-sh/github-action@v1 | |
| with: | |
| doc: ${{ matrix.doc }} | |
| token: ${{ secrets[matrix.token] }} | |
| file: api/specs/${{ matrix.doc }}-${{ matrix.version }}.yaml | |
| branch: ${{ matrix.version }} |