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
name: CI
on:
push:
branches:
pull_request:
branches:
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: "-D warnings"
# Run every JS action on Node.js 24 ahead of GitHub's forced migration,
# silencing "Node.js 20 actions are deprecated" runner warnings.
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: "true"
jobs:
test:
name: Test (${{ matrix.os }} / ${{ matrix.rust }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os:
rust:
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}
components: clippy, rustfmt
- uses: Swatinem/rust-cache@v2
- name: Format
run: cargo fmt --all -- --check
- name: Clippy (default features)
run: cargo clippy --all-targets -- -D warnings
- name: Clippy (all features)
run: cargo clippy --all-targets --all-features -- -D warnings
- name: Clippy (no default features)
run: cargo clippy --all-targets --no-default-features -- -D warnings
- name: Test (default features)
run: cargo test
- name: Test (all features)
run: cargo test --all-features
- name: Test (no default features)
run: cargo test --no-default-features
- name: Build examples
run: cargo build --examples
# Both modes: a doc link to a feature-gated item breaks only when that
# feature is off (dev/PLAN.md, D-014).
- name: Doc (default features)
run: cargo doc --no-deps
env:
RUSTDOCFLAGS: "-D warnings"
- name: Doc (all features)
run: cargo doc --no-deps --all-features
env:
RUSTDOCFLAGS: "-D warnings"
complexity:
# The complexity tests hold an optimised build to the time bound of
# dev/PLAN.md section 11.6; the test jobs above run them unoptimised,
# where only the limit errors are checked (D-073).
name: Complexity (release)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Linear time at 1 KiB, 64 KiB, and 1 MiB
run: cargo test --release --test complexity
no-std:
name: Bare metal (thumbv7em-none-eabi / ${{ matrix.rust }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
rust:
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}
targets: thumbv7em-none-eabi
components: clippy
- uses: Swatinem/rust-cache@v2
with:
key: thumbv7em
# A target with no `std` at all proves the core never reaches for it
# (dev/PLAN.md, NFR-5). `alloc` builds there too.
- name: Build (no features)
run: cargo build --target thumbv7em-none-eabi --no-default-features
- name: Build (alloc)
run: cargo build --target thumbv7em-none-eabi --no-default-features --features alloc
- name: Clippy (no features)
run: cargo clippy --target thumbv7em-none-eabi --no-default-features -- -D warnings
zero-deps:
name: Zero runtime dependencies
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@stable
- name: The default build depends on nothing
shell: bash
run: |
set -euo pipefail
# `cargo tree -e normal` prints the crate itself and nothing under it
# when the default build has no runtime dependencies (NFR-14).
tree=$(cargo tree -e normal --prefix none)
lines=$(printf '%s\n' "$tree" | grep -c . || true)
if [ "$lines" -ne 1 ]; then
echo "parse-net must have zero runtime dependencies in its default build (dev/PLAN.md, D-001)."
printf '%s\n' "$tree"
exit 1
fi
echo "$tree"
benches:
# The benchmark crate (benches/) is its own workspace with the
# competitor crates as its dependencies; building it here keeps it
# compiling without adding anything to parse-net's own builds.
name: Benchmarks build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
with:
workspaces: benches
- name: Build the benchmarks
working-directory: benches
run: cargo bench --no-run
package:
name: Package
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Package
run: cargo package
security:
name: Security (audit + deny)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Install cargo-audit and cargo-deny
uses: taiki-e/install-action@v2
with:
tool: cargo-audit,cargo-deny
- name: Generate lockfile
run: cargo generate-lockfile
- name: Audit
run: cargo audit
- name: Deny
run: cargo deny check