ledgrrr/.github/workflows/docs.yml at main · PromptExecution/ledgrrr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
name: Docs

on:
  push:
    branches: [main]
    tags: ['v[0-9]*']
  workflow_dispatch:

permissions:
  contents: write

env:
  TOOL_MDBOOK_VERSION: "0.5.0"
  TOOL_MDBOOK_MERMAID_VERSION: "0.17.0"

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Setup Node
        uses: actions/setup-node@v4

      - name: Install just
        run: cargo install just --locked

      - name: Install mdBook toolchain
        run: |
          cargo install mdbook --version "$TOOL_MDBOOK_VERSION" --locked
          cargo install mdbook-mermaid --version "$TOOL_MDBOOK_MERMAID_VERSION" --locked

      - name: Install mdbook-admonish
        # TODO: pin to a released version once tommilligan/mdbook-admonish#235 merges
        run: cargo install --git https://github.com/padamson/mdbook-admonish.git --branch feat/mdbook-0.5-compat mdbook-admonish

      - name: Install mdbook-rhai-mermaid
        run: cargo install --path crates/mdbook-rhai-mermaid

      - name: Validate GitHub Pages docs payload
        run: just docgen-pages-check

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./book/book