crucible/.github/workflows/docs.yml at main · neuralmagic/crucible · 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
name: Docs

# Build the mdBook doc site and deploy it to GitHub Pages.
#
#   * Pull requests: build the book and attach it as an artifact + sticky preview comment.
#   * Push to main / manual: build and deploy to Pages.
on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'book.toml'
      - '.github/workflows/docs.yml'
  pull_request:
    paths:
      - 'docs/**'
      - 'book.toml'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

env:
  MDBOOK_VERSION: "0.4.52"
  MDBOOK_MERMAID_VERSION: "0.15.0"

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write # post the sticky docs-preview comment on PRs
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
      - name: Install mdBook
        uses: taiki-e/install-action@9e1e5806d4a4822de933115878265be9aaa786d9 # v2.82.2
        with:
          tool: mdbook@${{ env.MDBOOK_VERSION }},mdbook-mermaid@${{ env.MDBOOK_MERMAID_VERSION }}
      - name: Build the book
        run: mdbook build

      # ---- PR preview: attach this PR's rendered book ----
      - name: Upload PR preview artifact
        id: preview
        if: ${{ github.event_name == 'pull_request' }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: docs-preview
          path: book
      # Fork PRs get a read-only GITHUB_TOKEN, so the sticky comment would hard-fail there;
      # same-repo PRs only. Fork contributors still get the artifact from the step above.
      - name: Comment the preview link
        if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository }}
        uses: marocchino/sticky-pull-request-comment@0ea0beb66eb9baf113663a64ec522f60e49231c0 # v3.0.4
        with:
          header: docs-preview
          message: |
            **Docs preview** for this PR is built and attached as the `docs-preview` artifact.

            **[Download `docs-preview`](${{ steps.preview.outputs.artifact-url }})**, unzip, and open `index.html` in a browser.

            _Rebuilt for ${{ github.event.pull_request.head.sha }}._

      # ---- Hand the book to the deploy job on non-PR runs ----
      - name: Upload Pages artifact
        if: ${{ github.event_name != 'pull_request' }}
        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
        with:
          path: book

  # Deploy the book to GitHub Pages. Only on main / manual.
  deploy:
    if: ${{ github.event_name != 'pull_request' }}
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deploy.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deploy
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4