From 1ef0793245d342cb9744143aac8c13b72a810bb0 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Fri, 21 Jun 2024 02:04:52 -0700 Subject: [PATCH] [OAS] Add deployment GitHub action (#186487) ## Summary This PR adds a new GitHub workflow to publish an [OpenAPI document](https://github.com/elastic/kibana/blob/main/oas_docs/kibana.serverless.yaml) to https://www.elastic.co/docs/api/doc/serverless, per https://docs.bump.sh/help/continuous-integration/github-actions/ --- .github/workflows/bump.yml | 60 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 .github/workflows/bump.yml diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml new file mode 100644 index 0000000000000..4e8bd45fd8690 --- /dev/null +++ b/.github/workflows/bump.yml @@ -0,0 +1,60 @@ +name: Check & deploy API documentation + +on: + push: + branches: + - main + paths: + - 'oas_docs/kibana.serverless.yaml' + + pull_request: + branches: + - main + paths: + - 'oas_docs/kibana.serverless.yaml' + +permissions: + contents: read + pull-requests: write + +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: serverless + token: ${{secrets.BUMP_TOKEN}} + file: oas_docs/kibana.serverless.yaml + + 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: Create Preview + uses: bump-sh/github-action@v1 + with: + doc: serverless + token: ${{secrets.BUMP_TOKEN}} + file: oas_docs/kibana.serverless.yaml + command: preview + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + - name: Comment pull request with API diff + uses: bump-sh/github-action@v1 + with: + doc: serverless + token: ${{secrets.BUMP_TOKEN}} + file: oas_docs/kibana.serverless.yaml + command: diff + fail_on_breaking: true + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}