caliptra-web/.github/workflows/publish-gh-pages.yml at 7b0460122293da8fb7fa0ddab26c3c1b37b2ea90 · chipsalliance/caliptra-web · 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
name: GitHub Pages

on:
  push:
    branches: [ main ]
  workflow_dispatch:
  schedule:
    - cron: '0 6 * * *'  # nightly at 6:00 UTC

jobs:
  build-and-deploy:
    runs-on: ubuntu-22.04

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

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Check out repository with LFS
        uses: actions/checkout@v4
        with:
          lfs: true
          fetch-depth: 0

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

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'

      - name: Install prerequisites
        run: |
          sudo apt-get update && sudo apt-get install -y pngcrush
          npm install
          pip install -r tools/requirements-build_docs.txt

      - name: Build
        run: |
          npm run build

      - name: Install mdbook
        env:
          MDBOOK_VERSION: "0.4.43"
          MDBOOK_MERMAID_VERSION: "0.14.0"
          MDBOOK_PLANTUML_VERSION: "0.8.0"
        run: |
          mkdir -p $HOME/.local/bin
          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 $HOME/.local/bin
          curl -sSL "https://github.com/badboy/mdbook-mermaid/releases/download/v${MDBOOK_MERMAID_VERSION}/mdbook-mermaid-v${MDBOOK_MERMAID_VERSION}-x86_64-unknown-linux-gnu.tar.gz" | tar xz -C $HOME/.local/bin
          cargo install mdbook-plantuml --version "=${MDBOOK_PLANTUML_VERSION}" --no-default-features
          echo "$HOME/.local/bin" >> $GITHUB_PATH

      - name: Build docs
        run: |
          python tools/build_docs.py --output book --verbose

      - name: Copy docs into dist
        run: cp -r book/* dist/docs/

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: dist/

      - name: Deploy to GitHub Pages
        id: deployment
        if: github.ref == 'refs/heads/main'
        uses: actions/deploy-pages@v4