name: Docs
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: cspell check
uses: streetsidesoftware/cspell-action@v8
with:
strict: true
suggestions: true
incremental_files_only: false
use_cspell_files: true
config: 'cspell.json'
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: 'latest'
- name: Install mdbook-mermaid
run: cargo install mdbook-mermaid
- name: Build documentation
run: mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: book
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4