Guard README install versions against drift #293

Merged
stephen merged 2 commits from chore/install-version-guard into main 2026-10-17 09:54:58 +00:00
Owner

The README hard-codes the release in five places (the badge, the tarball URL and directory, and cargo install --tag), and nothing ties them to Cargo.toml. A release that forgets them ships a README pointing at the previous version.

readme_install_snippets_match_cargo_version now fails when any of those snippets disagrees with CARGO_PKG_VERSION, listing each stale line. It only reads versions behind the four install markers, so fj release create v1.2.3 and names like fj-claude-plugin are left alone, and it fails if it finds no snippets at all rather than passing on nothing. Bumping Cargo.toml alone to 0.6.1 locally fails it with all five lines. docs/release.md names the README in the bump step.

Also corrects CLAUDE.md, which said tokens are never written to disk. They fall back to a 0600 tokens.toml in the config dir when the keychain is unavailable or FJ_NO_KEYCHAIN=1 is set.

This is the fj half of the 0.7.0 "stop doc drift" work; the docs.fjord.sh half lands in fjord-docs.

Stacked on #292 (the rustls bump the audit gate needs); merge that first.

The README hard-codes the release in five places (the badge, the tarball URL and directory, and `cargo install --tag`), and nothing ties them to `Cargo.toml`. A release that forgets them ships a README pointing at the previous version. `readme_install_snippets_match_cargo_version` now fails when any of those snippets disagrees with `CARGO_PKG_VERSION`, listing each stale line. It only reads versions behind the four install markers, so `fj release create v1.2.3` and names like `fj-claude-plugin` are left alone, and it fails if it finds no snippets at all rather than passing on nothing. Bumping `Cargo.toml` alone to 0.6.1 locally fails it with all five lines. docs/release.md names the README in the bump step. Also corrects CLAUDE.md, which said tokens are never written to disk. They fall back to a 0600 `tokens.toml` in the config dir when the keychain is unavailable or `FJ_NO_KEYCHAIN=1` is set. This is the fj half of the 0.7.0 "stop doc drift" work; the docs.fjord.sh half lands in fjord-docs. Stacked on #292 (the rustls bump the audit gate needs); merge that first.
Update rustls past four RustSec advisories
All checks were successful
ci / check (pull_request) Successful in 21m22s
ci / coverage (pull_request) Successful in 5m53s
ci / live-e2e (pull_request) Successful in 6m15s
b7c32dd8de
RUSTSEC-2026-0346 through 0349 landed against rustls 0.23.45 and fail the
audit gate. The lockfile moves to 0.23.46; nothing in fj's own manifest
changes.
Fail tests when README install snippets drift from Cargo.toml
All checks were successful
ci / check (pull_request) Successful in 21m0s
ci / coverage (pull_request) Successful in 5m23s
ci / live-e2e (pull_request) Successful in 6m9s
d690e4702d
Also correct CLAUDE.md: tokens fall back to a 0600 tokens.toml when the
keychain is unavailable or FJ_NO_KEYCHAIN is set.
stephen deleted branch chore/install-version-guard 2026-10-17 09:54:58 +00:00
Sign in to join this conversation.
No description provided.