Deploy redoc to github pages #3
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: OpenAPI | |
on: | |
push: | |
branches: [ "main" ] | |
pull_request: | |
branches: [ "main" ] | |
jobs: | |
lint: | |
name: Lint | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Set up node | |
uses: actions/setup-node@v4 | |
- name: Install Redocly CLI | |
run: npm install -g @redocly/cli@latest | |
- name: Run linting | |
run: redocly lint openapi/*/openapi.yaml --format=github-actions | |
build: | |
name: Build | |
runs-on: ubuntu-latest | |
needs: lint | |
steps: | |
- name: Create output directory | |
run: mkdir -p build | |
- name: Build pre-5 | |
run: redocly build-docs openapi/pre-5/openapi.yaml --output build/pre-5.html --format=github-actions | |
- name: Build pre-7 | |
run: redocly build-docs openapi/pre-7/openapi.yaml --output build/pre-7.html --format=github-actions | |
- name: Setup Pages | |
if: github.ref == 'refs/heads/main' | |
uses: actions/configure-pages@v3 | |
- name: Upload Artifact | |
if: github.ref == 'refs/heads/main' | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: ./build | |
deploy: | |
if: github.ref == 'refs/heads/main' | |
runs-on: ubuntu-latest | |
needs: build | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |