stygian/.github/workflows/docs.yml at main · greysquirr3l/stygian · 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - "book/**"
      - "docs/**"
      - "crates/**"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    name: Build mdBook + rustdoc
    runs-on: ubuntu-latest
    env:
      MDBOOK_VERSION: "0.4.43"
    steps:
      - uses: actions/checkout@v4

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

      - name: Cache cargo
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-doc-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: ${{ runner.os }}-cargo-doc-

      - name: Install mdBook
        run: |
          curl -sSL \
            "https://github.com/rust-lang/mdBook/releases/download/v${MDBOOK_VERSION}/mdbook-v${MDBOOK_VERSION}-x86_64-unknown-linux-gnu.tar.gz" \
            | tar -xz -C /usr/local/bin mdbook
          mdbook --version

      - name: Build book
        run: mdbook build book

      - name: Build rustdoc
        run: cargo doc --workspace --no-deps --all-features
        env:
          RUSTDOCFLAGS: "-Dwarnings"

      - name: Merge rustdoc into book output
        run: |
          mkdir -p book/book/api
          cp -r target/doc/. book/book/api/
          # redirect /api/ → stygian_graph crate index
          cat > book/book/api/index.html << 'HTML'
          <!DOCTYPE html>
          <html>
          <head>
            <meta charset="utf-8">
            <meta http-equiv="refresh" content="0; url=stygian_graph/index.html">
            <title>stygian API docs</title>
          </head>
          <body><p><a href="stygian_graph/index.html">stygian_graph</a></p></body>
          </html>
          HTML

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: book/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