Skip to content

Commit

Permalink
Actions: Add Github Pages deploy
Browse files Browse the repository at this point in the history
Deploys OpenAPI documentation to pages.

Signed-off-by: kingbri <[email protected]>
  • Loading branch information
bdashore3 committed Jul 8, 2024
1 parent 6613e38 commit 62c7f4d
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy OpenAPI docs to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["document-api"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install Python dependencies
run: |
python -m pip install --upgrade pip
pip install .
- name: Install Node dependencies
run: |
npm install @redocly/cli -g
- name: Export OpenAPI docs
run: EXPORT_OPENAPI=1 python main.py
- name: Build and store Redocly site
run: |
redocly build-docs openapi.json
mkdir static
mv redoc-static.html static/index.html
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload static HTML
path: 'static'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 62c7f4d

Please sign in to comment.