users-guide.yml

name: Publish user's guide

# Update the user's guide at https://strawlab.github.io/strand-braid/.
# The sitemap is at https://strawlab.github.io/strand-braid/sitemap.xml.
on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: strand-braid-user/users-guide
    steps:
      - uses: actions/checkout@v4

      - name: Install static-sitemap-cli
        run: npm install static-sitemap-cli

      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v2
        with:
          mdbook-version: '0.4.5'

      # Sitemap stuff from https://github.com/sunshowers-code/rust-cli-recommendations/blob/main/.github/workflows/docs.yml

      - name: Build book
        run: |
          mdbook build

      - name: Generate sitemap
        run: |
          cd book
          npx sscli --no-clean --base https://strawlab.github.io/strand-braid

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: strand-braid-user/users-guide/book