ConfigForge/.github/workflows/docs.yml at main · Azure/ConfigForge · 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
name: docs

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
      - 'README.md'
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: read

# CF-SEC-009 — pin both the mdbook-mermaid version AND the SHA256 of
# the prebuilt tarball. The previous workflow streamed the tarball
# straight into `tar -xz` with no integrity check; a compromised GitHub
# release asset or transit MITM could have executed arbitrary code in
# the docs build job. Keep both jobs in sync via these env vars.
env:
  MDBOOK_MERMAID_VERSION: '0.14.0'
  MDBOOK_MERMAID_TARBALL: 'mdbook-mermaid-v0.14.0-x86_64-unknown-linux-gnu.tar.gz'
  MDBOOK_MERMAID_SHA256: '37364965fb190cf9929d93c930c6b6c69b2fed05f7658ea2d312882ed59c645e'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Install mdBook
        uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08 # v2.0.0
        with:
          mdbook-version: '0.4.40'

      - name: Install mdbook-mermaid (verified)
        run: |
          set -euo pipefail
          URL="https://github.com/badboy/mdbook-mermaid/releases/download/v${MDBOOK_MERMAID_VERSION}/${MDBOOK_MERMAID_TARBALL}"
          curl -sSfL "$URL" -o "$MDBOOK_MERMAID_TARBALL"
          echo "${MDBOOK_MERMAID_SHA256}  ${MDBOOK_MERMAID_TARBALL}" | sha256sum -c -
          tar -xzf "$MDBOOK_MERMAID_TARBALL"
          chmod +x mdbook-mermaid
          rm -f "$MDBOOK_MERMAID_TARBALL"
          echo "$PWD" >> "$GITHUB_PATH"

      - name: Stage mermaid assets
        run: |
          cd docs
          mdbook-mermaid install .

      - name: Lint markdown
        uses: DavidAnson/markdownlint-cli2-action@21c1be1b93ad9ed58fa840aacc3f279cde2a72ff # v24.2.0
        with:
          globs: 'docs/src/**/*.md'

      - name: Build book
        run: cd docs && mdbook build

      - name: Upload artifact
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: book
          path: docs/book
          retention-days: 7

  deploy:
    needs: build
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Install mdBook
        uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08 # v2.0.0
        with:
          mdbook-version: '0.4.40'

      - name: Install mdbook-mermaid (verified)
        run: |
          set -euo pipefail
          URL="https://github.com/badboy/mdbook-mermaid/releases/download/v${MDBOOK_MERMAID_VERSION}/${MDBOOK_MERMAID_TARBALL}"
          curl -sSfL "$URL" -o "$MDBOOK_MERMAID_TARBALL"
          echo "${MDBOOK_MERMAID_SHA256}  ${MDBOOK_MERMAID_TARBALL}" | sha256sum -c -
          tar -xzf "$MDBOOK_MERMAID_TARBALL"
          chmod +x mdbook-mermaid
          rm -f "$MDBOOK_MERMAID_TARBALL"
          echo "$PWD" >> "$GITHUB_PATH"

      - name: Stage mermaid assets
        run: |
          cd docs
          mdbook-mermaid install .

      - name: Build book
        run: cd docs && mdbook build

      - name: Deploy to gh-pages
        uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/book
          publish_branch: gh-pages
          force_orphan: true
          commit_message: 'docs: deploy ${{ github.sha }}'