Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OAS] Add deployment GitHub action #186487

Merged
merged 5 commits into from
Jun 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions .github/workflows/bump.yml
Original file line number Diff line number Diff line change
@@ -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}}