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

on:
  pull_request:
  push:
    branches: [main, desktop]

jobs:
  rustdoc:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: stable
          components: rustfmt, clippy

      - name: Install system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libasound2-dev libx11-dev libxi-dev libxtst-dev libxrandr-dev libxext-dev libxrender-dev libxfixes-dev libxcomposite-dev libxcursor-dev libxdo-dev libglib2.0-dev libgtk-3-dev libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev pkg-config

      - name: Cache cargo
        uses: Swatinem/rust-cache@v2

      - name: Build docs with warnings as errors
        env:
          RUSTDOCFLAGS: "-D warnings"
        run: cargo doc --workspace --no-deps

      - name: Run doctests
        run: cargo test --workspace --doc

      - name: Clippy - enforce docs on private items
        run: cargo clippy --workspace -- -D clippy::missing_docs_in_private_items