Skip to content

Workflow file for this run

name: Build and Deploy MkDocs Site
on:
release:
types: [published]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v3 # build docs on main
- uses: actions/cache@v2
with:
key: ${{ github.ref }}
path: .cache
- name: Install dependencies
run: pip install mkdocs mkdocs-material mkdocs-minify-plugin
- name: Build site
run: |
cp -f README.md docs/index.md
cp -f LICENSE docs/license.md
cp -f CONTRIBUTING.md docs/nav/development/contributing-guide.md
mkdocs build --clean
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: 'site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1