CI: generate openapi contract before asking for contract diff #38
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: Check & deploy API documentation on Bump.sh 💙 | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| pull_request: | |
| branches: | |
| - main | |
| - master | |
| jobs: | |
| deploy-doc: | |
| if: ${{ github.event_name == 'push' }} | |
| name: Deploy API documentation on Bump.sh | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Deploy API documentation | |
| uses: bump-sh/github-action@v1 | |
| with: | |
| doc: apiplatform-test-demo | |
| token: ${{secrets.BUMP_TOKEN}} | |
| file: docs/openapi.json | |
| api-diff: | |
| if: ${{ github.event_name == 'pull_request' }} | |
| name: Check API diff on Bump.sh | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Build docker image | |
| uses: docker/build-push-action@v5 | |
| with: | |
| context: . | |
| file: ./api/Dockerfile | |
| tags: local:latest | |
| load: true | |
| cache-from: type=gha | |
| cache-to: type=gha,mode=max | |
| push: false | |
| - name: Generate OpenAPI contract | |
| uses: addnab/docker-run-action@v3 | |
| with: | |
| image: local:latest | |
| options: -v ${{ github.workspace }}:/work | |
| run: | | |
| php bin/console api:openapi:export > /work/docs/openapi.json | |
| - name: Comment pull request with API diff | |
| uses: bump-sh/github-action@v1 | |
| with: | |
| doc: apiplatform-test-demo | |
| token: ${{secrets.BUMP_TOKEN}} | |
| file: docs/openapi.json | |
| command: diff | |
| env: | |
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |