name: Deploy user guide to GitHub Pages
on:
push:
branches:
- master
paths:
- "guide/**"
- ".github/workflows/guide.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: "0.5.4"
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Clean output directory
run: rm -rf guide/book
- name: Build English book
run: mdbook build guide/en
- name: Build Chinese book
run: mdbook build guide/zh-Hans
- name: Add language selector homepage
run: cp guide/index.html guide/book/index.html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./guide/book
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4