-
Notifications
You must be signed in to change notification settings - Fork 76
675 lines (647 loc) · 30.3 KB
/
Copy pathpublish.yml
File metadata and controls
675 lines (647 loc) · 30.3 KB
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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
name: publish
# Release pipeline. Two phases with a HARD BARRIER between them, plus a single
# preflight gate in front of everything.
#
# release-preflight (GATE): the hard tier (scripts/release/prepare.py --check
# — tag/dispatch version == source tree, version sync across every §1b spot,
# Python/TS + Rust FFI + abihash drift, Swift ABI pin, and lockfile
# freshness) gates the WHOLE run. A soft infra doctor only warns. Nothing
# builds or publishes until this passes, so a mistag/drift/stale-lock stops
# the run before any expensive matrix work or immutable upload.
#
# VALIDATE (Actions artifacts only — no registry touched): wheels
# (python-wheels.yml), cuda-windows (cuda-windows.yml), swift-build
# (xcframework -> artifact, NOT the Release), rust-verify (cargo publish
# --dry-run + packed-crate smoke). These run on BOTH a release tag and a
# workflow_dispatch rehearsal; Windows CUDA is release-required, not special.
#
# PUBLISH (tags only — immutable uploads): create-release, publish-pypi,
# rust-release, ts-release, release-assets each `needs:` the FULL validation
# set, so no immutable publish (crates.io / PyPI / npm / GitHub Release) can
# start while any release-required lane is still unproven — retiring the
# 0.0.1/0.0.2 crates burns. finalize-release flips the draft Release public
# only after all four publishers land.
#
# REHEARSAL (workflow_dispatch): the VALIDATE jobs plus publish-testpypi /
# smoke-testpypi / rust-rehearsal / swift-rehearsal / ts-rehearsal — full
# build + TestPyPI clean-install, NO prod registry touched. Requires a
# `version` input that release-preflight asserts equals the source tree.
#
# Auth is PyPI Trusted Publishing (OIDC) — no PyPI tokens; crates =
# CARGO_REGISTRY_TOKEN; npm = NPM_TOKEN; Release assets / draft = GITHUB_TOKEN.
#
# NOTE: (Test)PyPI filenames are write-once — a failed rehearsal iteration
# means bumping the version (scripts/release/prepare.py X.Y.Z) and re-running.
on:
push:
tags: ["v[0-9]*"]
workflow_dispatch:
inputs:
version:
description: "X.Y.Z being rehearsed — MUST equal the source tree version (release-preflight asserts it)."
required: true
type: string
# Never two publishes at once; never cancel one mid-upload.
concurrency:
group: publish
cancel-in-progress: false
jobs:
# ===========================================================================
# GATE — runs first on every event; everything else `needs:` it.
# ===========================================================================
release-preflight:
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 20
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: actions/setup-node@v4
with:
node-version: 22
- uses: astral-sh/setup-uv@v8.2.0
- name: Install preflight deps (libclang for cargo xtask bindgen)
run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
- name: Assert the tag / dispatch version equals the source tree
id: srcver
run: |
set -euo pipefail
src="$(grep -E '^#define TRANSCRIBE_VERSION_(MAJOR|MINOR|PATCH) ' include/transcribe.h \
| grep -oE '[0-9]+$' | paste -sd. -)"
echo "source tree version: $src"
if [ "${GITHUB_EVENT_NAME}" = "push" ]; then
if [ "${GITHUB_REF_NAME}" != "v${src}" ]; then
echo "::error::tag ${GITHUB_REF_NAME} does not match the source version v${src} — retag the prepared commit."
exit 1
fi
else
want='${{ inputs.version }}'
if [ "${want}" != "${src}" ]; then
echo "::error::dispatch version ${want} does not match the source version ${src}."
exit 1
fi
fi
echo "version=$src" >> "$GITHUB_OUTPUT"
echo "version assertion ok"
- name: Hard tier — public-registry availability (no reused/burned version)
run: |
set -euo pipefail
ver='${{ steps.srcver.outputs.version }}'
if [ "${GITHUB_EVENT_NAME}" = "push" ]; then
uv run --no-project scripts/release/check_registries.py "$ver"
else
uv run --no-project scripts/release/check_registries.py "$ver" --rehearsal
fi
- name: Hard tier — release consistency (prepare.py --check)
run: uv run --no-project scripts/release/prepare.py --check
- name: Soft tier — infra doctor (warns only, never gates)
continue-on-error: true
env:
GH_TOKEN: ${{ github.token }}
HF_TOKEN: ${{ secrets.HF_TOKEN }}
MODAL_TOKEN_ID: ${{ secrets.MODAL_TOKEN_ID }}
MODAL_TOKEN_SECRET: ${{ secrets.MODAL_TOKEN_SECRET }}
run: uv run --no-project scripts/release/doctor.py
# ===========================================================================
# VALIDATE — build + verify only; produce Actions artifacts, touch no
# registry. Runs on a tag AND a rehearsal. The publish phase below `needs:`
# the full set [release-preflight, wheels, cuda-windows, swift-build,
# rust-verify].
# ===========================================================================
wheels:
# Full build + validation matrix; the artifacts published below are the
# exact files these workflows tested post-repair.
needs: [release-preflight]
uses: ./.github/workflows/python-wheels.yml
secrets: inherit
cuda-windows:
# The heaviest build in the project (nvcc over ggml-cuda x 5 arches under
# MSVC, ~3 h). Now release-required on BOTH events: a rehearsal proves it
# too, and no immutable publish starts until it is green.
needs: [release-preflight]
uses: ./.github/workflows/cuda-windows.yml
secrets: inherit
swift-build:
# Tags only — the tag-path validation twin of swift-rehearsal. Build the
# xcframework + checksum and stash the zip as an ACTIONS ARTIFACT; the upload
# to the GitHub Release happens later in release-assets (publish phase), so
# no release asset exists until the whole validation phase is green.
if: startsWith(github.ref, 'refs/tags/v')
needs: [release-preflight]
runs-on: blacksmith-6vcpu-macos-15
steps:
- uses: actions/checkout@v4
- run: brew install ninja
- name: Build the full xcframework
run: scripts/ci/build_xcframework.sh
- name: Package + checksum
id: pkg
run: |
scripts/ci/package_xcframework.sh | tee pkg.txt
echo "checksum=$(awk '/checksum:/ {print $2}' pkg.txt)" >> "$GITHUB_OUTPUT"
- name: Checksum for the mirror repo's Package.swift (informational)
run: |
echo "binaryTarget(url: .../TranscribeCpp.xcframework.zip,"
echo " checksum: \"${{ steps.pkg.outputs.checksum }}\")"
- name: Stash the xcframework as an artifact (attached to the Release in release-assets)
uses: actions/upload-artifact@v7
with:
name: swift-xcframework
path: bindings/swift/build-apple/TranscribeCpp.xcframework.zip
if-no-files-found: error
rust-verify:
# Tags only — the tag-path validation twin of rust-rehearsal. Dry-run the
# sys crate (full verify build, as cargo would publish it) and run the
# packed-crate smoke; NO upload. The safe crate cannot be dry-run-verified
# pre-publish (sys-first ordering), so the packed smoke exercises it instead.
if: startsWith(github.ref, 'refs/tags/v')
needs: [release-preflight]
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 40
env:
HF_TOKEN: ${{ secrets.HF_TOKEN }}
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: astral-sh/setup-uv@v8.2.0
- name: Install build deps
run: sudo apt-get update && sudo apt-get install -y cmake ninja-build
- name: Dry-run transcribe-cpp-sys (full verify build, as cargo would publish it)
run: cargo publish --dry-run --allow-dirty -p transcribe-cpp-sys
- uses: ./.github/actions/fetch-canary
with:
hf-token: ${{ secrets.HF_TOKEN }}
- name: Packed-crate smoke (build the native lib from the shipped tarball, transcribe)
run: uv run --no-project python scripts/ci/rust_packed_smoke.py
# ===========================================================================
# REHEARSAL — workflow_dispatch only. Proves the shipped artifacts against
# TestPyPI / packed tarballs without touching prod registries.
# ===========================================================================
publish-testpypi:
# Rehearsal target (dispatch only — real tags go to PyPI).
# Blacksmith, not the Hetzner box: gh-action-pypi-publish is a Docker
# container action and needs docker on the runner.
#
# TestPyPI filenames are WRITE-ONCE, so this upload waits on the full
# rehearsal validation matrix (Windows CUDA + the Rust/Swift/TS rehearsal
# lanes), not just the wheels — the same "no immutable publish while any
# release-required lane is unproven" rule the tag path enforces. A later
# CUDA/Swift/TS failure must not force a version bump just to re-rehearse.
if: github.event_name == 'workflow_dispatch'
needs: [release-preflight, wheels, cuda-windows, rust-rehearsal, swift-rehearsal, ts-rehearsal]
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 30
environment: testpypi
permissions:
id-token: write # OIDC for trusted publishing
steps:
- uses: actions/download-artifact@v8
with:
pattern: dist-*
merge-multiple: true
path: dist
- run: ls -la dist/
- uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: https://test.pypi.org/legacy/
packages-dir: dist
smoke-testpypi:
# The point of the rehearsal: a clean machine installs from TestPyPI
# alone (resolver pulls the native provider through the hard pin) and
# transcribes. Mirrors clean-install, but the index is the real thing.
needs: [publish-testpypi]
runs-on: blacksmith-2vcpu-ubuntu-2404
container: python:3.12-slim
timeout-minutes: 30
env:
HF_TOKEN: ${{ secrets.HF_TOKEN }}
steps:
- uses: actions/download-artifact@v8
with:
name: dist-api
path: dist-api
- uses: actions/download-artifact@v8
with:
# samples/jfk.wav (+ the degradation script), uploaded by api-wheel;
# files keep their repo-relative paths inside the artifact.
name: smoke-assets
path: smoke-assets
- name: Install from TestPyPI (exact just-published version) and transcribe
run: |
set -e
ver=$(ls dist-api/transcribe_cpp-*.whl | sed -E 's/.*transcribe_cpp-([0-9][^-]*)-.*/\1/')
echo "published version: $ver"
# TestPyPI can lag a few seconds behind a fresh upload; retry.
for i in $(seq 1 10); do
pip install -q \
--index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple/ \
"transcribe-cpp==$ver" && break
echo "index not ready yet ($i); retrying in 30s" && sleep 30
done
python - <<'EOF'
import transcribe_cpp as t
print("provider:", t.native_provider())
print("devices:", [(d.name, d.kind) for d in t.backends()])
assert t.backend_available("cpu")
EOF
if [ -z "$HF_TOKEN" ]; then
echo "no HF_TOKEN (fork?) — install-only check passed, skipping the model smoke"
exit 0
fi
pip install -q huggingface_hub
hf download handy-computer/whisper-tiny-gguf \
whisper-tiny-Q5_K_M.gguf --local-dir canary
python - <<'EOF'
import array, wave
import transcribe_cpp as t
with wave.open("smoke-assets/samples/jfk.wav", "rb") as w:
pcm16 = array.array("h"); pcm16.frombytes(w.readframes(w.getnframes()))
pcm = array.array("f", (s / 32768.0 for s in pcm16))
with t.Model("canary/whisper-tiny-Q5_K_M.gguf") as m, m.session() as s:
text = s.run(pcm).text
print("text:", text.strip())
assert "country" in text.lower(), text
print("ok: clean machine installed from TestPyPI and transcribed")
EOF
rust-rehearsal:
# Dispatch only — the rehearsal twin of rust-verify.
if: github.event_name == 'workflow_dispatch'
needs: [release-preflight]
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 40
env:
HF_TOKEN: ${{ secrets.HF_TOKEN }}
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- uses: astral-sh/setup-uv@v8.2.0 # fetch-canary + the packed-smoke script
- name: Install build deps
run: sudo apt-get update && sudo apt-get install -y cmake ninja-build
- name: Dry-run transcribe-cpp-sys (full verify build, as cargo would publish it)
run: cargo publish --dry-run --allow-dirty -p transcribe-cpp-sys
# The safe crate cannot be dry-run-verified pre-publish: it depends on
# transcribe-cpp-sys = "0.0.x", and the registry only has the placeholder
# until sys actually publishes (sys-first ordering). Its packaging is
# verified at release time below; here the packed-crate smoke exercises it
# against the packed sys instead.
- uses: ./.github/actions/fetch-canary
with:
hf-token: ${{ secrets.HF_TOKEN }}
- name: Packed-crate smoke (build the native lib from the shipped tarball, transcribe)
run: uv run --no-project python scripts/ci/rust_packed_smoke.py
swift-rehearsal:
# Dispatch only — the rehearsal twin of swift-build: build the real
# xcframework and run the suite against it (transcribes the canary through
# the published shape).
if: github.event_name == 'workflow_dispatch'
needs: [release-preflight]
runs-on: [self-hosted, macOS, ARM64]
env:
HF_TOKEN: ${{ secrets.HF_TOKEN }}
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v8.2.0
- run: brew install ninja
- name: Build the full xcframework (macOS + iOS device + iOS simulator)
run: scripts/ci/build_xcframework.sh
- name: Package + checksum (proves the release artifact + licenses)
run: scripts/ci/package_xcframework.sh
- uses: ./.github/actions/fetch-canary
with:
hf-token: ${{ secrets.HF_TOKEN }}
- name: swift test against the built xcframework
working-directory: bindings/swift
run: swift test
ts-rehearsal:
# Dispatch only. Pack the API + a platform package, install from the
# tarballs into a clean dir, and transcribe the canary — exactly the
# clean-machine path, no TRANSCRIBE_LIBRARY.
if: github.event_name == 'workflow_dispatch'
needs: [release-preflight]
runs-on: [self-hosted, macOS, ARM64]
env:
HF_TOKEN: ${{ secrets.HF_TOKEN }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- uses: astral-sh/setup-uv@v8.2.0
- run: command -v ninja >/dev/null || brew install ninja
- name: Build + install a shared libtranscribe (the native-bundle twin)
run: |
cmake -B build-shared -G Ninja -DTRANSCRIBE_BUILD_SHARED=ON \
-DGGML_METAL=ON -DGGML_METAL_EMBED_LIBRARY=ON
cmake --build build-shared --target transcribe
cmake --install build-shared --prefix "$PWD/ts-native"
- name: Pack API + platform tarballs
working-directory: bindings/typescript
run: |
npm install --no-audit --no-fund
npm run build
ver="$(node -p "require('./package.json').version")"
node scripts/pack-platform.mjs --lib-dir "$GITHUB_WORKSPACE/ts-native/lib" \
--tuple darwin-arm64-metal --version "$ver" --out /tmp/ts-platform
rm -rf /tmp/ts-tarballs && mkdir -p /tmp/ts-tarballs
npm pack --pack-destination /tmp/ts-tarballs
(cd /tmp/ts-platform/darwin-arm64-metal && npm pack --pack-destination /tmp/ts-tarballs)
- uses: ./.github/actions/fetch-canary
with:
hf-token: ${{ secrets.HF_TOKEN }}
- name: Install from tarballs (clean dir) and transcribe the canary
run: |
rm -rf /tmp/ts-consumer && mkdir -p /tmp/ts-consumer
(cd /tmp/ts-consumer && npm init -y >/dev/null && \
npm install --no-audit --no-fund /tmp/ts-tarballs/*.tgz)
TS_PKG_ENTRY=/tmp/ts-consumer/node_modules/transcribe-cpp/dist/index.js \
TRANSCRIBE_SMOKE_AUDIO="$GITHUB_WORKSPACE/samples/jfk.wav" \
node scripts/ci/ts_packed_smoke.mjs
# ===========================================================================
# PUBLISH — tags only. Each immutable upload `needs:` the FULL validation set,
# so nothing is published while any release-required lane is still unproven.
# ===========================================================================
create-release:
# Owns creation of the GitHub Release object — created AFTER validation, not
# at workflow start. Keep it draft until the mandatory publishers have
# succeeded and assets are verified (finalize-release).
if: startsWith(github.ref, 'refs/tags/v')
needs: [release-preflight, wheels, cuda-windows, swift-build, rust-verify, ts-pack]
runs-on: blacksmith-2vcpu-ubuntu-2404
permissions:
contents: write
steps:
- name: Create the draft release for the tag
env:
GH_TOKEN: ${{ github.token }}
run: |
set -e
tag="${GITHUB_REF_NAME}"
gh release view "$tag" --repo "$GITHUB_REPOSITORY" >/dev/null 2>&1 || \
gh release create "$tag" --repo "$GITHUB_REPOSITORY" \
--title "$tag" --notes "transcribe.cpp $tag" --verify-tag --draft
publish-pypi:
# The real thing. Gate: only version tags reach this, and the `pypi`
# environment carries the approval rule once the repo is public. Waits for
# the full validation set — including cuda-windows even when CU12_ON_PYPI is
# false: PyPI should not go public while a release-required lane is unproven.
# Also waits on create-release: no immutable registry upload starts unless the
# GitHub Release object itself was created (else PyPI could land with no Release).
if: startsWith(github.ref, 'refs/tags/v')
needs: [create-release, release-preflight, wheels, cuda-windows, swift-build, rust-verify, ts-pack]
# Blacksmith for the same docker-container-action reason as testpypi.
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 30
environment: pypi
permissions:
id-token: write
steps:
- uses: actions/download-artifact@v8
with:
pattern: dist-*
merge-multiple: true
path: dist
- name: Add cu12 wheels (only once the PyPI size request is granted)
if: vars.CU12_ON_PYPI == 'true'
uses: actions/download-artifact@v8
with:
pattern: cuda-dist-*
merge-multiple: true
path: dist
- run: ls -la dist/
- uses: pypa/gh-action-pypi-publish@release/v1
with:
packages-dir: dist
rust-release:
# Tags only. Releases are cut from CI, never a laptop (requirements §5).
# sys publishes FIRST (the safe crate resolves it by version), then the safe
# crate. `crates-io` carries the approval gate + CARGO_REGISTRY_TOKEN. NOW
# gated behind the full validation set AND create-release (it previously had
# NO needs: and could burn the immutable crates.io version before anything
# else built, or before the Release object even existed).
if: startsWith(github.ref, 'refs/tags/v')
needs: [create-release, release-preflight, wheels, cuda-windows, swift-build, rust-verify, ts-pack]
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 40
environment: crates-io
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
steps:
- uses: actions/checkout@v6
- uses: dtolnay/rust-toolchain@stable
- name: Install build deps
run: sudo apt-get update && sudo apt-get install -y cmake ninja-build
- name: Publish transcribe-cpp-sys (the native-carrying crate; verifies the build)
run: cargo publish -p transcribe-cpp-sys
- name: Publish transcribe-cpp (the safe wrapper; resolves the just-published sys)
run: cargo publish -p transcribe-cpp
ts-pack:
# Tags only — VALIDATION-phase TS packaging (NO npm publish). Build each
# @transcribe-cpp/<platform> package from its native bundle (the exact bytes
# the wheels shipped) + the pure-TS API package, sync the platform pins, and
# `npm pack` them all to .tgz uploaded as the `ts-tarballs` artifact. The
# publish job consumes those exact bytes, so a packaging failure can never
# land AFTER PyPI/crates have already started.
if: startsWith(github.ref, 'refs/tags/v')
needs: [release-preflight, wheels]
runs-on: blacksmith-2vcpu-ubuntu-2404
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- uses: actions/download-artifact@v8
with:
pattern: native-*
merge-multiple: true
path: native-bundles
- name: Build + pack platform packages and the API package
working-directory: bindings/typescript
run: |
set -e
npm install --no-audit --no-fund
npm run build
ver="$(node -p "require('./package.json').version")"
# Sync the API package's @transcribe-cpp/* platform pins to the version
# we publish, so the packed API tarball pins the exact bytes we ship
# (the static gate in check_version_sync.py enforces the base match;
# this nails the exact pin). Without this the pins go stale on the first
# version bump and the install resolves a mismatched native -> AbiError.
node -e '
const fs = require("node:fs");
const v = process.argv[1];
const p = JSON.parse(fs.readFileSync("package.json", "utf8"));
for (const k of Object.keys(p.optionalDependencies || {})) p.optionalDependencies[k] = v;
fs.writeFileSync("package.json", JSON.stringify(p, null, 2) + "\n");
' "$ver"
out=/tmp/ts-platform
# build-tuple (bundle) -> npm tuple (Node platform-arch convention)
map() { case "$1" in
macos-arm64-metal) echo darwin-arm64-metal ;;
macos-x86_64-cpu) echo darwin-x64-cpu ;;
linux-x86_64-cpu-vulkan) echo linux-x64-cpu-vulkan ;;
linux-aarch64-cpu-vulkan) echo linux-arm64-cpu-vulkan ;;
windows-x86_64-cpu-vulkan) echo win32-x64-cpu-vulkan ;;
*) echo "" ;; esac; }
for f in "$GITHUB_WORKSPACE"/native-bundles/transcribe-native-*.tar.gz; do
base="$(basename "$f" .tar.gz)"; build_tuple="${base#transcribe-native-}"
npm_tuple="$(map "$build_tuple")"
[ -n "$npm_tuple" ] || { echo "::warning::no npm tuple for $build_tuple"; continue; }
ex="/tmp/extract/$build_tuple"; rm -rf "$ex"; mkdir -p "$ex"; tar xzf "$f" -C "$ex"
libdir="$(dirname "$(find "$ex" \( -name 'libtranscribe.*' -o -name 'transcribe.dll' \) | head -1)")"
node scripts/pack-platform.mjs --lib-dir "$libdir" --tuple "$npm_tuple" --version "$ver" --out "$out"
done
# Pack to .tgz: platform packages and the API package into separate dirs
# so the publish job can order them (platforms first, API last).
rm -rf /tmp/ts-tarballs && mkdir -p /tmp/ts-tarballs/platform /tmp/ts-tarballs/api
for d in "$out"/*/; do
(cd "$d" && npm pack --pack-destination /tmp/ts-tarballs/platform)
done
npm pack --pack-destination /tmp/ts-tarballs/api
- uses: actions/upload-artifact@v7
with:
name: ts-tarballs
path: /tmp/ts-tarballs
if-no-files-found: error
ts-release:
# Tags only — PUBLISH phase. Download the tarballs ts-pack validated and npm
# publish those exact bytes (platform packages first so the API package's
# optionalDependencies resolve at install time). Publishing a pre-packed
# tarball does NOT re-run prepublishOnly, so no build happens here — only the
# upload. The `npm` environment carries the approval gate.
if: startsWith(github.ref, 'refs/tags/v')
needs: [create-release, release-preflight, wheels, cuda-windows, swift-build, rust-verify, ts-pack]
runs-on: blacksmith-2vcpu-ubuntu-2404
environment: npm
steps:
- uses: actions/setup-node@v4
with:
node-version: 22
registry-url: "https://registry.npmjs.org"
- uses: actions/download-artifact@v8
with:
name: ts-tarballs
path: ts-tarballs
- name: Publish platform packages, then the API package
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
set -e
for t in ts-tarballs/platform/*.tgz; do
echo "publishing $t"
npm publish "$t" --access public
done
npm publish ts-tarballs/api/*.tgz --access public # the API package (transcribe-cpp)
release-assets:
# cu12's primary distribution home (wheels as GitHub release assets, served
# to pip through the PEP 503 index on Pages), the canonical native bundles,
# AND the Swift xcframework (built+validated in swift-build, uploaded here).
if: startsWith(github.ref, 'refs/tags/v')
needs: [create-release, release-preflight, wheels, cuda-windows, swift-build, rust-verify, ts-pack]
# Blacksmith, not the hetzner self-hosted box: this job only downloads
# artifacts and `gh release upload`s them, and the hetzner runner has no `gh`
# on PATH (release v0.0.3 failed here with "gh: command not found"). The
# other gh-using publishers (create-release, finalize-release) already run on
# Blacksmith, where gh is preinstalled.
runs-on: blacksmith-2vcpu-ubuntu-2404
timeout-minutes: 30
permissions:
contents: write # upload release assets
steps:
- uses: actions/download-artifact@v8
with:
pattern: cuda-dist-*
merge-multiple: true
path: cu12
# The canonical native bundles (extracted from the repaired wheels by
# python-wheels.yml). On the release they become the distribution home
# for non-PyPI ecosystems: npm platform packages and prebuilt-Rust
# fetch these exact bytes by tag instead of rebuilding.
- uses: actions/download-artifact@v8
with:
pattern: native-*
merge-multiple: true
path: native-bundles
# The Swift xcframework zip produced by swift-build in the validation phase.
- uses: actions/download-artifact@v8
with:
name: swift-xcframework
path: swift
- name: Attach the cu12 wheels
env:
GH_TOKEN: ${{ github.token }}
run: |
set -e
tag="${GITHUB_REF#refs/tags/}"
gh release upload "$tag" cu12/*.whl --repo "$GITHUB_REPOSITORY" --clobber
- name: Attach the native bundles (versioned names)
env:
GH_TOKEN: ${{ github.token }}
run: |
set -e
tag="${GITHUB_REF#refs/tags/}"
ver="${tag#v}"
mkdir -p upload
for f in native-bundles/transcribe-native-*.tar.gz; do
base="$(basename "$f" .tar.gz)"
tuple="${base#transcribe-native-}"
cp "$f" "upload/transcribe-native-${ver}-${tuple}.tar.gz"
done
ls -la upload/
gh release upload "$tag" upload/*.tar.gz --repo "$GITHUB_REPOSITORY" --clobber
- name: Attach the Swift xcframework
env:
GH_TOKEN: ${{ github.token }}
run: |
set -e
tag="${GITHUB_REF#refs/tags/}"
gh release upload "$tag" swift/TranscribeCpp.xcframework.zip \
--repo "$GITHUB_REPOSITORY" --clobber
finalize-release:
# Tags only. Publish the draft GitHub Release only after its hosted assets
# AND all four immutable publishers (PyPI, crates.io, npm, Release assets)
# have completed — so the public Release can't finalize before crates/npm
# have landed (closes sharp-edge #5).
if: startsWith(github.ref, 'refs/tags/v')
needs: [publish-pypi, rust-release, ts-release, release-assets]
runs-on: blacksmith-2vcpu-ubuntu-2404
permissions:
contents: write # publish the draft release
actions: write # dispatch wheel-index
steps:
- name: Verify assets and publish the release
env:
GH_TOKEN: ${{ github.token }}
run: |
set -euo pipefail
tag="${GITHUB_REF_NAME}"
ver="${tag#v}"
assets_file="$(mktemp)"
gh release view "$tag" --repo "$GITHUB_REPOSITORY" \
--json assets --jq '.assets[].name' | sort > "$assets_file"
echo "Release assets:"
sed 's/^/ /' "$assets_file"
require_asset() {
name="$1"
if ! grep -Fxq "$name" "$assets_file"; then
echo "::error::missing release asset: $name"
exit 1
fi
}
require_asset "TranscribeCpp.xcframework.zip"
require_asset "transcribe-native-${ver}-linux-x86_64-cpu-vulkan.tar.gz"
require_asset "transcribe-native-${ver}-linux-aarch64-cpu-vulkan.tar.gz"
require_asset "transcribe-native-${ver}-macos-arm64-metal.tar.gz"
require_asset "transcribe-native-${ver}-macos-x86_64-cpu.tar.gz"
require_asset "transcribe-native-${ver}-windows-x86_64-cpu-vulkan.tar.gz"
cu12_count="$(grep -Ec '^transcribe_cpp_native_cu12-.*\.whl$' "$assets_file" || true)"
if [ "$cu12_count" -lt 2 ]; then
echo "::error::expected at least two cu12 provider wheels, found $cu12_count"
exit 1
fi
gh release edit "$tag" --repo "$GITHUB_REPOSITORY" --draft=false
- name: Refresh the PEP 503 index (requires Pages enabled on the repo)
env:
GH_TOKEN: ${{ github.token }}
run: |
gh workflow run wheel-index.yml --repo "$GITHUB_REPOSITORY" || \
echo "::warning::wheel-index dispatch failed — is the workflow on the default branch and Pages enabled?"