bittide-hardware/.github/workflows/deploy-documentation.yml at 0390acdfcaaeaa64d7d12e7b94ac10d6ed060d2f · bittide/bittide-hardware · 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
# SPDX-FileCopyrightText: 2025 Google LLC
#
# SPDX-License-Identifier: Apache-2.0

name: Deploy documentation

on:
  push:
    branches:
      - main

jobs:
  mdbook:
    name: Build and publish mdBook
    runs-on: [self-hosted, compute]
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write
      id-token: write
    defaults:
      run:
        shell: git-nix-shell {0} --ignore-environment
    container:
      image: ghcr.io/clash-lang/nixos-bittide-hardware:2025-11-24
      options: --memory=11g
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set CI flags
        run: |
          .github/scripts/set_ci_flags.sh

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

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

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4