clawdstrike/.github/workflows/docs.yml at 44f52cc5d128cb79740296b6d969e6070ce80ef1 · backbay-labs/clawdstrike · 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
92
93
94
95
# Hushclaw Documentation Deployment
#
# Builds and deploys the mdBook documentation site to GitHub Pages.
#
# Triggers:
# - Push to main branch (docs/** changes)
# - Manual workflow dispatch

name: Deploy Documentation

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

# Sets permissions of the GITHUB_TOKEN for Pages deployment
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment
concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v2
        with:
          mdbook-version: "0.4.40"

      - name: Build documentation
        run: |
          cd docs
          mdbook build

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: docs/book

  # Deployment job
  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

  # Link checker (runs in parallel)
  linkcheck:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup mdBook
        uses: peaceiris/actions-mdbook@v2
        with:
          mdbook-version: "0.4.40"

      - name: Install link checker
        run: |
          cargo install mdbook-linkcheck --version 0.7.7 --locked

      - name: Build with link check
        run: |
          cd docs
          mdbook build
        env:
          MDBOOK_OUTPUT__LINKCHECK: "{}"

      - name: Report broken links
        if: failure()
        run: |
          echo "::warning::Broken links detected in documentation"