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

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'overrides/**'
      - '.github/workflows/docs.yml'
      - 'crates/auths-cli/src/**'
      - 'crates/xtask/src/**'
      - 'packages/auths-python/**'
      - 'packages/auths-node/**'
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - 'overrides/**'
      - 'crates/auths-cli/src/**'
      - 'crates/xtask/src/**'
      - 'packages/auths-python/**'
      - 'packages/auths-node/**'

permissions:
  contents: write

jobs:
  deploy:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0  # full history for git-revision-date

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

      - name: Cache Rust build
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: ${{ runner.os }}-cargo-

      - name: Regenerate CLI docs
        run: cargo run -p xtask -- gen-docs

      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - uses: actions/setup-node@v4
        with:
          node-version: '20'

      - uses: pnpm/action-setup@v4
        with:
          version: 10

      - name: Generate Node SDK API docs
        working-directory: packages/auths-node
        run: |
          pnpm install --frozen-lockfile
          npx typedoc

      - name: Install dependencies
        run: pip install mkdocs-material "mkdocstrings[python]"

      - name: Build docs (PR check)
        if: github.event_name == 'pull_request'
        run: mkdocs build --strict

      - name: Build mkdocs
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: mkdocs build --strict