rf24-rs/.github/workflows/docs.yml at 3ed91182c7a07e5cd2514b60103d75130a379da3 · nRF24/rf24-rs · 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
name: Docs

on:
  push:
    branches: [main]
    paths:
      - docs/**
      - crates/rf24-rs/**
      - '**/*.md'
      - .github/workflows/docs.yml
  pull_request:
    branches: [main]
    paths:
      - docs/**
      - crates/rf24-rs/**
      - '**/*.md'
      - .github/workflows/docs.yml

permissions: {}

jobs:
  supplemental:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          persist-credentials: false
      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
        with:
          enable-cache: true
      - uses: actions/setup-node@v6
        with:
          node-version: 24.x
          cache: yarn
      - run: yarn install
      - name: Install cargo-binstall
        uses: cargo-bins/cargo-binstall@dc19f1e48450eefe5a29b8da6c6b00a87d730b37 # v1.18.1
      - name: Install nur
        run: cargo binstall -y nur
      - run: nur docs build
      - name: Save docs build as artifact
        uses: actions/upload-artifact@v7
        with:
          path: docs/site
          name: supplemental-docs

  api:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          persist-credentials: false
      - name: Setup Rust
        run: rustup update --no-self-update
      - name: Install cargo-binstall
        uses: cargo-bins/cargo-binstall@dc19f1e48450eefe5a29b8da6c6b00a87d730b37 # v1.18.1
      - name: Install nur
        run: cargo binstall -y nur
      - name: Cache deps
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: cargo-docs-${{ hashFiles('crates/*/src/**', 'crates/**/Cargo.toml') }}
      - run: nur docs rs
      - name: save docs as artifact
        uses: actions/upload-artifact@v7
        with:
          name: api-docs
          path: target/doc