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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
name: CI
on:
push:
branches:
- main
paths-ignore:
- 'README'
- 'COPYRIGHT'
- 'LICENSE-*'
- '**.md'
- '**.txt'
pull_request:
paths-ignore:
- 'README'
- 'COPYRIGHT'
- 'LICENSE-*'
- '**.md'
- '**.txt'
schedule:
- cron: "0 1 1 * *"
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: -Dwarnings
RUST_BACKTRACE: 1
nightly: nightly
stable: stable
jobs:
# Check formatting (platform-independent, one OS is enough).
rustfmt:
name: rustfmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Install Rust
run: rustup update stable && rustup default stable && rustup component add rustfmt
- name: Check formatting
run: cargo fmt --all -- --check
# Verify the declared MSRV in Cargo.toml still builds.
msrv:
name: msrv
runs-on: ubuntu-latest
env:
# MSRV-era compilers may emit warnings stable doesn't; don't deny them.
RUSTFLAGS: ""
steps:
- uses: actions/checkout@v6
- name: Read MSRV from Cargo.toml
id: msrv
run: |
ver=$(grep -m1 '^rust-version' Cargo.toml | sed -E 's/.*"([^"]+)".*/\1/')
echo "version=$ver" >> "$GITHUB_OUTPUT"
- name: Install MSRV toolchain (${{ steps.msrv.outputs.version }})
run: rustup toolchain install ${{ steps.msrv.outputs.version }} --profile minimal
- name: cargo +MSRV check --all-features
run: cargo +${{ steps.msrv.outputs.version }} check --all-features
# Apply clippy lints across the feature powerset.
clippy:
name: clippy
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v6
- name: Install Rust
# --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
run: rustup update stable --no-self-update && rustup default stable && rustup component add clippy
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Apply clippy lints
run: cargo hack clippy --each-feature --all-targets
build:
name: build
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v6
- name: Cache cargo build and registry
uses: actions/cache@v5
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-build-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-build-
- name: Install Rust
# --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
run: rustup update stable --no-self-update && rustup default stable
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Run build
run: cargo hack build --feature-powerset
test:
name: test
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v6
- name: Cache cargo build and registry
uses: actions/cache@v5
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-test-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-test-
- name: Install Rust
# --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
run: rustup update stable --no-self-update && rustup default stable
- name: Install cargo-hack
uses: taiki-e/install-action@v2
with:
tool: cargo-hack
- name: Run test
run: cargo hack test --feature-powerset
coverage:
name: coverage
runs-on: ubuntu-latest
needs:
- rustfmt
- msrv
- clippy
- build
- test
steps:
- uses: actions/checkout@v6
- name: Install Rust
run: rustup update nightly && rustup default nightly
- name: Install cargo-tarpaulin
# Pin the tarpaulin version so CI and local runs track the same
# set of lines. Different tarpaulin versions can produce different
# totals (especially around macro-expanded code), which caused
# codecov numbers to drift from local runs.
uses: taiki-e/install-action@v2
with:
tool: cargo-tarpaulin@0.35.2
- name: Cache cargo registry
# Intentionally do NOT cache `target/`. Tarpaulin's instrumented
# artifacts can get reused across runs even when src/ or tests/
# change, which leaves stale `.gcno`-style hit data in the cache
# and causes CI to under-report coverage vs local runs.
uses: actions/cache@v5
with:
path: |
~/.cargo/registry
~/.cargo/git
key: ${{ runner.os }}-coverage-registry-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-coverage-registry-
- name: Print rustc / tarpaulin versions
run: |
rustc --version
cargo tarpaulin --version
- name: Force clean build
# Belt-and-suspenders: even without a `target/` cache, make sure
# tarpaulin always re-instruments this crate from source.
run: cargo clean -p peekable
- name: Run tarpaulin
env:
RUSTFLAGS: "--cfg tarpaulin"
run: cargo tarpaulin --all-features --run-types lib --run-types tests --run-types doctests --workspace --out xml
- name: Upload coverage report artifact
# Lets us download the exact cobertura.xml the CI produced and
# diff it locally against a local tarpaulin run — useful when
# codecov's reported number and local runs disagree.
if: always()
uses: actions/upload-artifact@v4
with:
name: cobertura-xml
path: cobertura.xml
if-no-files-found: warn
retention-days: 14
- name: Upload to codecov.io
uses: codecov/codecov-action@v6
with:
token: ${{ secrets.CODECOV_TOKEN }}
slug: ${{ github.repository }}
fail_ci_if_error: true