name: Docs
on:
workflow_dispatch:
push:
branches: [main]
paths:
- "docs/**"
- ".github/workflows/docs.yml"
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
name: Build mdBook
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: latest
- name: Build docs
run: mdbook build docs
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/book
deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4