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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
name: CI
on:
push:
branches:
pull_request:
branches:
env:
CARGO_TERM_COLOR: always
CARGO_INCREMENTAL: "0"
jobs:
# --------------------------------------------------------------
# Build + test the library + examples + integration tests on
# the two Tier-1 Unix targets holt supports today.
# --------------------------------------------------------------
test:
name: test (${{ matrix.os }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
steps:
- uses: actions/checkout@v6
# `rocksdb` is a dev-dependency (criterion bench harness pulls
# it in for the apples-to-apples comparison). Its C++ build
# needs libclang + LLVM headers.
- name: Install LLVM (Ubuntu)
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
- name: Install LLVM (macOS)
if: runner.os == 'macOS'
run: |
brew install llvm
echo "LIBCLANG_PATH=$(brew --prefix llvm)/lib" >> "$GITHUB_ENV"
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- name: Cache cargo registry + build
uses: Swatinem/rust-cache@v2
- name: cargo build
run: cargo build --workspace --all-targets --all-features --locked
- name: cargo test (lib + integration)
run: cargo test --workspace --all-features --lib --tests --examples --locked
- name: cargo test (doctests)
run: cargo test --workspace --all-features --doc --locked
- name: cargo run --example basic_kv
run: cargo run --example basic_kv --locked
- name: cargo run --example filesystem_meta
run: cargo run --example filesystem_meta --locked
- name: cargo run --example session_store
run: cargo run --example session_store --locked
- name: cargo run --example s3_metadata
run: cargo run --example s3_metadata --locked
# --------------------------------------------------------------
# Lint pass — formatting + clippy with deny(warnings) on top of
# the crate's pedantic lints.
# --------------------------------------------------------------
lint:
name: lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Install LLVM
run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- uses: Swatinem/rust-cache@v2
- name: cargo fmt --check
run: cargo fmt --all --check
# Clippy on tests + examples too, not just the library. The
# crate opts into `clippy::pedantic` and has a vetted set of
# `#![allow]`s in `src/lib.rs` for the unhelpful ones; any
# new warning fails the build.
- name: cargo clippy
run: cargo clippy --workspace --all-targets --all-features --locked -- -D warnings
# --------------------------------------------------------------
# Fuzz smoke — short libFuzzer run over the storage-engine model
# target. This is not a replacement for long fuzz campaigns; it is
# a CI guard that keeps the fuzz target building and exercises the
# atomic / WAL / range oracle for a bounded number of generated
# inputs.
# --------------------------------------------------------------
fuzz:
name: fuzz
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: dtolnay/rust-toolchain@nightly
- uses: Swatinem/rust-cache@v2
- name: install cargo-fuzz
run: cargo +stable install cargo-fuzz --locked
- name: cargo fuzz run atomic_model
run: cargo +nightly fuzz run atomic_model -- -runs=512
# --------------------------------------------------------------
# Coverage — source-based LLVM coverage over lib + integration
# tests + examples on Ubuntu. The line threshold is deliberately
# close to the current measured baseline so coverage can only move
# backward intentionally.
# --------------------------------------------------------------
coverage:
name: coverage
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Install LLVM
run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
- uses: dtolnay/rust-toolchain@stable
with:
components: llvm-tools-preview
- uses: Swatinem/rust-cache@v2
- name: install cargo-llvm-cov
run: cargo install cargo-llvm-cov --locked
- name: cargo llvm-cov
run: |
cargo llvm-cov clean --workspace
cargo llvm-cov \
--workspace --all-features --lib --tests --examples --locked \
--fail-under-lines 88
cargo llvm-cov report --fail-under-lines 88 > coverage.txt
cargo llvm-cov report --lcov --output-path lcov.info
cargo llvm-cov report --html --output-dir coverage
{
echo "## coverage"
echo ""
echo '```'
cat coverage.txt
echo '```'
} >> "$GITHUB_STEP_SUMMARY"
- name: Upload coverage artifacts
uses: actions/upload-artifact@v4
with:
name: coverage
path: |
coverage.txt
lcov.info
coverage/html
# --------------------------------------------------------------
# Criterion microbenches — run on both Tier-1 Unix targets so
# we can read the perf delta between the default
# `pread`/`pwrite` backend (macOS + Linux without feature) and
# the `--features io-uring` Linux build. Numbers go to the job
# summary as a Markdown table; no failure thresholds — variance
# on hosted runners is too high for hard SLOs, but eyeballing
# the deltas tells us if a commit massively regressed
# something. Measurement window is short (`--warm-up-time 1
# --measurement-time 2`) so a full CI run stays under ~5 min.
# --------------------------------------------------------------
bench:
name: bench (${{ matrix.os }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
steps:
- uses: actions/checkout@v6
- name: Install LLVM (Ubuntu)
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
- name: Install LLVM (macOS)
if: runner.os == 'macOS'
run: |
brew install llvm
echo "LIBCLANG_PATH=$(brew --prefix llvm)/lib" >> "$GITHUB_ENV"
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
# Filter to holt-only persist scenarios so the run stays
# focused (the full matrix also benches rocksdb / sqlite for
# the apples-to-apples comparison — those numbers belong in
# a separate "compare" job, not the regression gate).
- name: cargo bench (default backend)
run: |
set -o pipefail
cargo bench --bench main --locked -- \
--warm-up-time 1 --measurement-time 2 \
"persist_put/holt|persist_get/holt|persist_mixed/holt" \
2>&1 | tee bench-default.txt
- name: cargo bench (io-uring backend, Linux only)
if: runner.os == 'Linux'
run: |
set -o pipefail
cargo bench --bench main --features io-uring --locked -- \
--warm-up-time 1 --measurement-time 2 \
"persist_put/holt|persist_get/holt|persist_mixed/holt" \
2>&1 | tee bench-uring.txt
- name: Post results to job summary
if: always()
run: |
{
echo "## holt bench results — ${{ matrix.os }}"
echo ""
echo "### Default backend (\`pread\`/\`pwrite\`)"
echo '```'
grep -E "time:|thrpt:" bench-default.txt || echo "(no measurements captured)"
echo '```'
if [ -f bench-uring.txt ]; then
echo ""
echo "### \`--features io-uring\` backend"
echo '```'
grep -E "time:|thrpt:" bench-uring.txt || echo "(no measurements captured)"
echo '```'
fi
} >> "$GITHUB_STEP_SUMMARY"
- name: Upload raw bench logs
if: always()
uses: actions/upload-artifact@v4
with:
name: bench-${{ matrix.os }}
path: bench-*.txt
if-no-files-found: warn
# --------------------------------------------------------------
# `cargo doc` — fails on broken intra-doc links / missing docs
# so the rendered docs.rs page stays clean.
# --------------------------------------------------------------
docs:
name: docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Install LLVM
run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: cargo doc (no deps)
env:
RUSTDOCFLAGS: "-D warnings"
run: cargo doc --workspace --no-deps --locked
# --------------------------------------------------------------
# MSRV — pin to the rust-version field in Cargo.toml. Keeps us
# honest about the floor we promise downstream users. We build
# the library only (no tests/benches/examples) because
# dev-dependencies routinely require newer Rust than the
# library surface itself does.
# --------------------------------------------------------------
msrv:
name: msrv (rust 1.82)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@1.82
- uses: Swatinem/rust-cache@v2
- name: cargo build (library only)
run: cargo build --lib --locked
# --------------------------------------------------------------
# Supply-chain hygiene: `cargo deny check` fails the build on
# disallowed licenses, banned crates, RustSec advisories, and
# duplicate / unmaintained dependencies. Policy lives in
# `deny.toml` at the repo root.
# --------------------------------------------------------------
deny:
name: deny
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: EmbarkStudios/cargo-deny-action@v2
with:
command: check
arguments: --all-features --locked