diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml new file mode 100644 index 0000000..309fd07 --- /dev/null +++ b/.github/workflows/bump.yml @@ -0,0 +1,43 @@ +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@v3 + - 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}}