Skip to content

Auto update api docs and upload api docs to gh-pages (#1418) #1

Auto update api docs and upload api docs to gh-pages (#1418)

Auto update api docs and upload api docs to gh-pages (#1418) #1

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: deploy-api-docs
on:
# Runs on pushes targeting the default branch
push:
branches: ["unstable"]
# 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:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Only upload the api docs folder
path: "docs/api/*"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2