name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
env:
CARGO_TERM_COLOR: always
jobs:
fmt:
name: Format
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- run: cargo --locked fmt --all --check
clippy:
name: Clippy
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: actions/cache@v5
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-clippy-${{ hashFiles('**/Cargo.lock', 'rust-toolchain.toml') }}
restore-keys: |
${{ runner.os }}-cargo-clippy-
- run: cargo clippy --all-targets --locked -- -D warnings
doc:
name: Doc
runs-on: ubuntu-latest
timeout-minutes: 10
env:
RUSTDOCFLAGS: -D warnings
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- run: cargo doc --locked --no-deps
test:
name: Test (${{ matrix.os }})
runs-on: ${{ matrix.os }}
timeout-minutes: 90
env:
RUST_BACKTRACE: 1
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest]
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: actions/cache@v5
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-test-${{ hashFiles('**/Cargo.lock', 'rust-toolchain.toml') }}
restore-keys: |
${{ runner.os }}-cargo-test-
- run: cargo build --verbose --locked
- run: cargo test --verbose --locked
docs-gates:
name: Docs gates
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: bash tests/docs-target-blank-rel-noopener.sh
- run: bash tests/docs-no-http-links.sh
- run: bash tests/docs-no-inline-handlers.sh
polish-gates:
name: Polish gates
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: bash tests/man-page-no-trailing-whitespace.sh
- run: bash tests/man-page-final-newline.sh
- run: bash tests/man-page-synopsis-section.sh
- run: bash tests/tests-shell-executable.sh
- run: bash tests/tests-shell-shebang.sh
semantic-gates:
name: Semantic gates
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: bash tests/docs-has-h1.sh
- run: bash tests/docs-no-deprecated-tags.sh
- run: bash tests/docs-no-placeholder-href.sh
newline-gates:
name: Newline + README gates
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: bash tests/readme-final-newline.sh
- run: bash tests/docs-final-newline.sh
- run: bash tests/workflow-final-newline.sh
- run: bash tests/cargo-final-newline.sh
- run: bash tests/readme-has-https-link.sh
structure-gates:
name: Structure gates
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: bash tests/readme-has-h2-section.sh
- run: bash tests/readme-has-badges.sh
- run: bash tests/docs-has-html-closing.sh
- run: bash tests/docs-has-body-tag.sh
- run: bash tests/workflow-no-tabs.sh