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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
name: CI
on:
push:
branches:
pull_request:
env:
CARGO_TERM_COLOR: always
RUST_BACKTRACE: 1
jobs:
fmt:
name: Formatting
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt
- name: Check formatting
run: cargo fmt --all -- --check
clippy:
name: Clippy (all features)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: clippy
- uses: Swatinem/rust-cache@v2
- name: Lint (warnings are errors)
run: cargo clippy --all-features --all-targets -- -D warnings
test:
name: Test (debug + release)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Test (debug)
run: cargo test --all-features
# Release mode runs without overflow checks; both modes must agree.
- name: Test (release)
run: cargo test --all-features --release
msrv:
name: Test (MSRV 1.81)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@1.81.0
- uses: Swatinem/rust-cache@v2
- name: Test at the declared MSRV
run: cargo test --all-features
features:
name: Feature matrix
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
features:
- --no-default-features
- --no-default-features --features std
- --no-default-features --features serde
- --no-default-features --features binary
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Check every target with ${{ matrix.features }}
run: cargo check --all-targets ${{ matrix.features }}
- name: Unit tests with ${{ matrix.features }}
run: cargo test --lib ${{ matrix.features }}
doc:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Build docs (warnings are errors)
run: cargo doc --all-features --no-deps
env:
RUSTDOCFLAGS: -D warnings
audit:
name: Security audit
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
# `rustsec/audit-check` needs a Cargo.lock; generate one if the repo
# does not track it.
- name: Ensure a lockfile exists
run: cargo generate-lockfile
- name: Check dependencies against the RustSec advisory database
uses: rustsec/audit-check@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}