funkpower
69907eb186
WebAssembly rather than a native Node addon: one artifact serves Node, Deno, Bun, a browser and anything built on them, where napi would have meant a prebuilt binary per platform and a source build for whoever the matrix missed. The engine is pure computation and the menologion is already compiled in, so there is nothing for it to give up. A day comes back as a plain object, not a handle. A wasm class would have meant a .free() that every caller eventually forgets, and this way JSON.stringify works and the thing spreads into state. Two serializer defaults had to be overridden to keep the promise that it is the same document --json emits: maps as objects, and an absent field as null rather than undefined, which stringify would otherwise drop entirely. The TypeScript is hand-written, because the generated types for a value crossing as JsValue are `any`, and a binding that types its whole return as `any` is a binding TypeScript cannot check. tsc --strict is a release gate now, the way mypy --strict already is, and the check includes three lines that must fail to compile. The one place this differs from every other binding: no remembered default jurisdiction, because a browser has nowhere to keep one. It is called out in the README, in the types and in docs/versioning.md. The test resolves typikon through a staged node_modules rather than a relative path, so what it exercises is the exports map, and it compares a year of days field by field against the command line for four jurisdictions.
5.8 KiB
Releasing
The branching workflow
main is always releasable. Everything else is short-lived.
feat/whatever ──push──▶ ci runs tests
│
└──merge──▶ main ──tag v0.3.0──▶ release builds and publishes to PyPI
- Work on a branch. Pushing any branch runs
ci.yml: clippy, the Rust tests, the Python bindings built and tested against the freshly built CLI, and mypy against the stubs. - Merge to
mainwhen it is green. - Release by tagging.
Cargo.tomlcarries the version and the tag points at it. The first job refuses to continue if the two disagree, because PyPI will not let a version be reused — not even after it is yanked — so publishing 0.2.0 under a tag that says v0.3.0 cannot be undone.
$ # on main, working tree clean
$ sed -i 's/^version = .*/version = "0.3.0"/' Cargo.toml
$ cargo build # refresh Cargo.lock
$ git commit -am 'release 0.3.0'
$ git tag v0.3.0 && git push origin main v0.3.0
__version__ in Python comes from CARGO_PKG_VERSION, and maturin reads the
same field, so Cargo.toml is the only place a version is written.
Why pull requests do not trigger CI
ci.yml fires on push and nothing else. This forge is public and takes pull
requests from strangers; a runner executes whatever the workflow checks out, so a
pull_request trigger would run an unread stranger's code on the runner host.
Push-only means the runner only ever executes code that someone with push rights
put there.
The cost is real: a pull request gets no automatic check. Read the diff, push the branch yourself, and let it run then.
What has to exist first
1. Actions enabled on the forge
Off by default here, deliberately — see homedocs/services/forgejo-public.md.
In app.ini on moria:
[actions]
ENABLED = true
$ ssh moria 'cd ~/docker-services/forgejo-public && docker compose down && docker compose up -d'
Always restart the whole stack. network_mode: service:forge-wg means restarting
the forge alone silently strips its networking.
2. A runner
The forge has no default route and cannot address the LAN, so it cannot reach a runner. Runners poll outward, so register one against the public URL and let it come to the forge the same way any other client does:
$ forgejo-runner register --no-interactive \
--instance https://git.pumpin.online \
--token <from Settings → Actions → Runners> \
--name <host> --labels docker
It needs Docker and outbound internet — it fetches crates and wheels. It executes repository code, so put it somewhere you would be willing to lose, not on a host that matters. moria runs the MCP servers and the forge itself; that is the wrong box for it.
3. A PyPI token
Registered under the funkpower account. Make it project-scoped to
typikon, not account-wide, and add it as the repository secret PYPI_TOKEN.
PyPI's trusted publishing is OIDC and supports GitHub, GitLab, Google Cloud Build and ActiveState — not Forgejo. So this forge has to hold a long-lived credential, and scoping it to the one project is the whole of the mitigation available: if the forge is compromised, what is lost is the ability to publish typikon, not every package the account owns.
Rotate it at pypi.org/manage/account/token/ if the forge is ever suspect.
4. An npm token
Also under funkpower, also scoped to the one package, added as the
repository secret NPM_TOKEN. Make it a granular access token with write
on typikon alone; a classic automation token is account-wide.
npm has trusted publishing too, and it does not know this forge either, so the same tradeoff applies. Without the secret the release still succeeds and the npm step warns and skips, so the first release of a version after the token lapses is a PyPI release and nothing else. Check the run.
What gets published
typikon-X.Y.Z.tar.gz |
sdist — builds from source anywhere with a Rust toolchain |
…-cp39-abi3-manylinux…x86_64.whl |
|
…-cp39-abi3-manylinux…aarch64.whl |
cross-built with maturin --zig |
abi3, so one wheel per platform covers every Python from 3.9 up rather than one per interpreter.
And on npm, one package with two WebAssembly builds in it: node/ for Node,
which loads the module itself, and web/ for browsers and bundlers, which
cannot compile WebAssembly synchronously on the main thread and so has to be
awaited. The exports map picks between them. There are no per-platform
artefacts, because WebAssembly has no platforms.
No macOS or Windows wheels. Forgejo has no hosted runners, so those need a Mac and a Windows box registered as runners. Until then both fall back to the sdist, which needs a Rust toolchain on the installing machine — fine for developers, a wall for everyone else.
Checking a release without publishing
$ rm -rf dist # a wheel left in dist/ gets packed into the sdist
$ maturin sdist --out dist && maturin build --release --out dist
$ twine check dist/*
$ python -m venv /tmp/v && /tmp/v/bin/pip install --no-binary :all: dist/*.tar.gz
$ /tmp/v/bin/python -c 'import typikon, datetime; print(typikon.today())'
Installing from the sdist with --no-binary is the one that catches a missing
file, because it builds the crate from exactly what PyPI would hand someone.
For the npm package:
$ npm/build.sh && node npm/test.mjs
$ npm pack --dry-run npm/dist
npm/test.mjs resolves typikon through a staged node_modules, so it tests
the exports map and the built files rather than a lucky relative import. It
compares a year of days field by field against the command line, runs the web
build the way a browser would, and type-checks the published .d.ts under
tsc --strict. It needs wasm-bindgen on PATH at the version Cargo.lock
pins, and tsc for the last of those.