Actions: Add Github Pages deploy
Deploys OpenAPI documentation to pages. Signed-off-by: kingbri <bdashore3@proton.me>
This commit is contained in:
parent
6613e38436
commit
8a81fe2eb4
1 changed files with 65 additions and 0 deletions
65
.github/workflows/pages.yml
vendored
Normal file
65
.github/workflows/pages.yml
vendored
Normal file
|
|
@ -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: ["main"]
|
||||
|
||||
# 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
|
||||
Loading…
Add table
Add a link
Reference in a new issue