reth/.github/workflows/book.yml at cef883fc437887cc886d8c765e32b6b7fffa2801 · paradigmxyz/reth · 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
# Documentation and mdbook related jobs.

name: book

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
    types: [opened, reopened, synchronize, closed]
  merge_group:

env:
  RUSTC_WRAPPER: "sccache"

jobs:
  build:
    runs-on: ${{ github.repository == 'paradigmxyz/reth' && 'depot-ubuntu-latest-8' || 'ubuntu-latest' }}
    timeout-minutes: 90
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Install bun
        uses: oven-sh/setup-bun@v2
        with:
          bun-version: v1.2.23

      - name: Install Playwright browsers
        # Required for rehype-mermaid to render Mermaid diagrams during build
        run: |
          cd docs/vocs/
          bun i
          npx playwright install --with-deps chromium

      - name: Install Rust nightly
        uses: dtolnay/rust-toolchain@nightly

      - uses: mozilla-actions/sccache-action@v0.0.9

      - name: Build docs
        run: cd docs/vocs && bash scripts/build-cargo-docs.sh

      - name: Build Vocs
        run: |
          cd docs/vocs/ && bun run build
          echo "Vocs Build Complete"

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

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: "./docs/vocs/docs/dist"

  deploy:
    # Only deploy if a push to main
    if: github.ref_name == 'main' && github.event_name == 'push'
    runs-on: ubuntu-latest
    needs: [build]

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write
      id-token: write

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

    timeout-minutes: 60

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