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
name: CI
on:
push:
branches:
- main
paths-ignore:
- 'README'
- 'COPYRIGHT'
- 'LICENSE-*'
- '**.md'
- '**.txt'
pull_request:
paths-ignore:
- 'README'
- 'COPYRIGHT'
- 'LICENSE-*'
- '**.md'
- '**.txt'
workflow_dispatch:
schedule:
- cron: "0 1 1 * *"
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: -Dwarnings
RUST_BACKTRACE: 1
ASRY_FETCH_FIXTURES: '1'
jobs:
# Check formatting (platform-independent, one OS is enough)
rustfmt:
name: rustfmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
# Nightly toolchain — `rustfmt.toml` uses
# `imports_granularity = "Crate"`, an unstable feature only
# available on nightly. Without this the stable rustfmt
# silently drops the setting and reports diffs vs the
# nightly-formatted tree.
- name: Install Rust (nightly)
run: rustup update nightly --no-self-update && rustup default nightly && rustup component add rustfmt --toolchain nightly
- name: Check formatting
run: cargo fmt --all -- --check
# Apply clippy lints
clippy:
name: clippy
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v7
- 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: Apply clippy lints
# Explicit feature combos — see build job for rationale.
run: |
set -e
cargo clippy -- -D warnings
cargo clippy --features alignment -- -D warnings
cargo clippy --features alignment,serde -- -D warnings
cargo clippy --features alignment,bench-internals -- -D warnings
cargo clippy --no-default-features --features emissions -- -D warnings
cargo clippy --no-default-features --features emissions,serde -- -D warnings
if [ "$RUNNER_OS" = "macOS" ]; then
cargo clippy --features alignment,metal,coreml -- -D warnings
fi
shell: bash
# Run tests on some extra platforms
# `cross`, `sanitizer`, `miri-sb`, `miri-tb` removed: they are
# template defaults that don't fit asry's architecture.
# `Lang` is asry's own native pure-Rust enum (`src/types/lang.rs`),
# not re-exported from `whispercpp`, so the `emissions`-only combo
# (no `runner`, no `alignment`) compiles and clippy-passes without
# whisper.cpp or ONNX Runtime — see the `clippy`/`build`/`test`
# jobs' `--no-default-features --features emissions[,serde]` lines
# below. The default (`runner`) and `alignment` combos still
# require linking whisper.cpp (cmake + C++) and, for `alignment`,
# ONNX Runtime via load-dynamic. Neither dependency:
# * cross-compiles cleanly to the cross-job target list
# (wasm, i686, android, etc.) — `cmake + Foundation`
# framework lookups fail before we ever see asry
# code,
# * is meaningfully sanitizable / miri-evaluable from
# downstream — any UB those tools would find lives in
# whisper.cpp / ORT, which test themselves upstream.
# `emissions` is exactly the meaningful ORT/whisper.cpp-free subset
# this comment used to say would justify a scoped job (the trellis/
# beam/tokenize/normalize/compose algorithm factored out of
# `runner` — see Cargo.toml's `emissions` feature doc); it now has
# build/test/clippy coverage below.
#
# ORT/whisper.cpp-free is NOT pure-Rust, and the distinction is
# exactly the one this comment turns on. `emissions` enables
# `tokenizers` with `features = ["onig"]`, which pulls
# `onig v6.5.3` -> `onig_sys v69.9.3`; `onig_sys` declares
# `links = "onig"` and compiles ~57 C files of Oniguruma through
# `cc` in its build script. Verify with:
# cargo tree --no-default-features --features emissions -i onig_sys
#
# Do NOT read that as "Oniguruma is the only thing keeping cross /
# sanitizer / Miri out of scope" — an earlier version of this comment
# did, and it was overbroad. asry ALREADY compiles C under every
# feature combo, `--no-default-features` included, because
# `[build-dependencies] ureq` pulls `rustls` -> `ring` -> `cc`:
# cargo tree --no-default-features -e normal,build -i cc
#
# The two are not interchangeable. `ring` is a BUILD-dependency: it is
# host-compiled, never linked into the library, and invisible to Miri
# (which interprets the target crate graph, not build scripts) and to
# the target's sanitizers. `onig_sys` is a NORMAL dependency with a
# `links` key that rides into the built artifact. So `emissions` is the
# combo that adds native code to the LIBRARY; it is not the combo that
# first introduces a C compiler to the BUILD.
#
# Net: `cross`/`sanitizer`/`miri` stay out of scope for every feature
# combo — but for two independent reasons, and dropping the `onig`
# tokenizer feature would only remove one of them. Keep in sync with
# the `tokenizers` comment in Cargo.toml.
build:
name: build
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v7
- name: Cache cargo build and registry
uses: actions/cache@v6
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: Run build
# Explicit feature combos rather than `cargo hack
# --feature-powerset`: asry's features aren't fully
# orthogonal (`alignment` implies `runner` + `emissions`), and
# a full powerset would waste CI time on combos that can't
# build on some runners or are redundant with `alignment`.
# `Lang` is asry's own native pure-Rust enum
# (`src/types/lang.rs`), not re-exported from `whispercpp`, so
# the `emissions`-only combo below compiles without `runner`
# (no whisper.cpp, no ONNX Runtime). Apple-only `metal` /
# `coreml` only build on macOS; diagnostic toggles
# (`parity-dump-emission`, `bench-internals`) ship
# internals, never on the production surface.
run: |
set -e
cargo build
cargo build --features alignment
cargo build --features alignment,serde
cargo build --features alignment,bench-internals
cargo build --no-default-features --features emissions
cargo build --no-default-features --features emissions,serde
if [ "$RUNNER_OS" = "macOS" ]; then
cargo build --features alignment,metal,coreml
fi
shell: bash
test:
name: test
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
- windows-latest
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v7
- name: Cache cargo build and registry
uses: actions/cache@v6
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
# Audio parity fixtures (~283 MB of WAV + RTTM) live in the
# sibling repo `Findit-AI/audio-fixtures`, NOT in asry's
# git history. The fetch is opt-in via
# `ASRY_FETCH_FIXTURES=1` so the default `cargo test`
# path stays network-free and fast. Tests that need the
# fixtures gate themselves on the populated path
# (`tests/parity/fixtures/<name>/clip_16k.wav`) and
# short-circuit when absent.
- name: Fetch audio parity fixtures
if: env.ASRY_FETCH_FIXTURES == '1'
shell: bash
run: bash scripts/fetch_fixtures.sh
- name: Run test
# Explicit feature combos — see build job for rationale.
run: |
set -e
cargo test
cargo test --features alignment
cargo test --features alignment,serde
cargo test --features alignment,bench-internals
cargo test --no-default-features --features emissions
cargo test --no-default-features --features emissions,serde
shell: bash
coverage:
name: coverage
runs-on: ubuntu-latest
needs:
- rustfmt
- clippy
- build
- test
steps:
- uses: actions/checkout@v7
- name: Install Rust
run: rustup update nightly && rustup default nightly
- name: Install cargo-tarpaulin
run: cargo install cargo-tarpaulin
- name: Cache cargo build and registry
uses: actions/cache@v6
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-coverage-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-coverage-
- name: Fetch audio parity fixtures
if: env.ASRY_FETCH_FIXTURES == '1'
shell: bash
run: bash scripts/fetch_fixtures.sh
- name: Run tarpaulin
env:
RUSTFLAGS: "--cfg tarpaulin"
# Coverage runs Linux. `metal` / `coreml` need
# Apple frameworks; diagnostic toggles ship internals.
# Cover the full default-runner-and-alignment surface.
run: cargo tarpaulin --features alignment,serde,bench-internals --run-types tests --run-types doctests --workspace --out xml
- name: Upload to codecov.io
uses: codecov/codecov-action@v7
with:
token: ${{ secrets.CODECOV_TOKEN }}
slug: ${{ github.repository }}
fail_ci_if_error: true