Files
craft-libs/.github/workflows/docs.yml
T
aiongg 383a1fcb9d Fix next's CI baseline: action pins, rustfmt, a private doc link and clippy lints
- docs.yml and theme.yml use the locked action versions, with entries in actions.lock.
- rustfmt on ui-contract's style/mod.rs.
- hovers' doc no longer links the private Under.
- clippy: needless struct update in TextRun::job, a type alias and sort_by_key in winners_of,
  needless derefs in arena_clip, an unneeded mut in FooterBar.
2026-11-17 17:42:17 +00:00

36 lines
1.1 KiB
YAML

name: Docs
# Builds the documentation of every workspace crate with warnings as errors, so a public item
# without a doc comment or a broken doc link fails, including crates no other workflow covers.
on:
workflow_dispatch:
push:
branches: [main, next]
paths: ['crates/**', 'Cargo.toml', 'Cargo.lock', '.github/workflows/docs.yml']
pull_request:
paths: ['crates/**', 'Cargo.toml', 'Cargo.lock', '.github/workflows/docs.yml']
permissions:
contents: read
jobs:
docs:
timeout-minutes: 30
name: Workspace docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7.0.1
with:
# The token isn't needed after checkout; cargo runs build scripts and proc macros from
# dependencies, so don't leave it in .git/config for that third-party code to read.
persist-credentials: false
- uses: step-security/dtolnay-rust-toolchain@v1.0.0
with:
toolchain: stable
- uses: step-security/rust-cache@v2.9.2
- name: Docs (links and missing docs)
run: cargo doc --workspace --no-deps --locked --keep-going
env:
RUSTDOCFLAGS: -D warnings