Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
fix(release): bump icaptcha-client with the rest of the workspace
icaptcha-client became a workspace member in #138, after #130 last wrote
release-please-config.json, and nothing updated extra-files. release-please
rewrites a version line only when the line carries the annotation AND the
manifest is listed, so the crate was skipped every release and sat at 0.4.0
while the other five walked to 0.7.1.

Nothing broke: every intra-workspace path dep is bare, so no version
requirement could go unsatisfied; no crate is published to a registry; and
the crate reads no CARGO_PKG_VERSION of its own. The cost was the workspace
Cargo.toml comment asserting a lockstep rule the config did not keep, which
is what the next person adding a crate would read and copy.

Add the missing entry, and gate the rule so it cannot silently lapse again.
The gate derives its required set from `cargo metadata`, so a new crate reds
CI whether or not its author knows the gate exists, and it covers all three
release-silent shapes: a member absent from extra-files, a member whose
version line lost the annotation, and an extra-files path that is no longer
a member.

Next release moves icaptcha-client 0.4.0 to the current workspace version in
one step. Nothing depends on that version, so the jump is cosmetic.
  • Loading branch information
beardthelion committed Jul 30, 2026
commit 4f424693b83fcc656e28656e82207a1aa9b794cb
32 changes: 32 additions & 0 deletions .github/workflows/pr-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -283,3 +283,35 @@ jobs:

- name: Check gitlawb-core dependency allowlist
run: bash scripts/check-gitlawb-core-deps.sh

# release-please only rewrites a crate's version when the line carries the
# `# x-release-please-version` annotation AND the manifest is listed under
# extra-files in release-please-config.json. Miss either half and the crate
# is skipped silently at release time, freezing at its creation version:
# icaptcha-client was added as a workspace member after the config was last
# written and sat at 0.4.0 through four releases before anyone noticed.
# Exhaustive-by-construction, like the allowlist gate above: the required set
# is derived from `cargo metadata`, so a newly added crate reds CI whether or
# not its author knew this gate existed.
release-versioning:
name: release versioning coverage
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- name: Check out repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false

- name: Set up Rust toolchain
uses: dtolnay/rust-toolchain@b3b07ba8b418998c39fb20f53e8b695cdcc8de1b # stable
with:
toolchain: stable

- name: Cache cargo
uses: Swatinem/rust-cache@98c8021b550208e191a6a3145459bfc9fb29c4c0 # v2.8.0
with:
key: release-versioning

- name: Check every workspace crate is release-managed
run: bash scripts/check-release-versioning.sh
3 changes: 2 additions & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
{ "type": "generic", "path": "crates/gitlawb-node/Cargo.toml" },
{ "type": "generic", "path": "crates/gl/Cargo.toml" },
{ "type": "generic", "path": "crates/git-remote-gitlawb/Cargo.toml" },
{ "type": "generic", "path": "crates/gitlawb-attest/Cargo.toml" }
{ "type": "generic", "path": "crates/gitlawb-attest/Cargo.toml" },
{ "type": "generic", "path": "crates/icaptcha-client/Cargo.toml" }
]
}
}
Expand Down
108 changes: 108 additions & 0 deletions scripts/check-release-versioning.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
#!/usr/bin/env bash
#
# Release-versioning coverage gate for the workspace crates.
#
# release-please owns every crate's version. It rewrites a version line only
# when BOTH halves hold: the line carries an `# x-release-please-version`
# annotation, and the crate's manifest is listed under `extra-files` in
# release-please-config.json. A crate missing either half is silently skipped
# at release time and freezes at whatever version it was created with, which
# is exactly what happened to icaptcha-client (added as a workspace member
# after the config was last written, so it sat at 0.4.0 while the rest of the
# workspace walked to 0.7.1 across four releases).
#
# Exhaustive-by-construction: the required set is DERIVED from the workspace
# member list via `cargo metadata`, never from a hand-maintained list here. A
# newly added crate reds CI whether or not anyone remembered this gate exists,
# which is the property a hand list cannot have.
#
# Hard-fail directions, all three release-silent:
# 1. a workspace member absent from extra-files
# 2. a workspace member whose version line lacks the annotation
# 3. an extra-files entry pointing at a manifest that no longer exists
#
# Runnable from anywhere in the repo.
set -euo pipefail

ROOT="$(git rev-parse --show-toplevel)"
CONFIG="$ROOT/release-please-config.json"

if [ ! -f "$CONFIG" ]; then
echo "ERROR: release-please config not found at $CONFIG" >&2
exit 1
fi

# Resolving can refresh Cargo.lock as a side effect, so snapshot and restore it:
# this check must never leave the working tree dirty when run locally. Same
# reasoning as scripts/check-gitlawb-core-deps.sh.
lock_backup="$(mktemp)"
cp "$ROOT/Cargo.lock" "$lock_backup"
restore_lock() { cp "$lock_backup" "$ROOT/Cargo.lock"; rm -f "$lock_backup"; }
trap restore_lock EXIT

# Workspace members as repo-relative manifest paths, one per line. This is the
# derived required set: whatever cargo considers a member must be release-managed.
members="$(
cargo metadata --no-deps --format-version 1 --manifest-path "$ROOT/Cargo.toml" \
| jq -r '.packages[].manifest_path' \
| sed "s#^$ROOT/##" \
| sort -u
)"

# Manifest paths release-please is configured to rewrite.
listed="$(jq -r '.packages["."]["extra-files"][] | .path' "$CONFIG" | sort -u)"

unlisted="$(comm -23 <(printf '%s\n' "$members") <(printf '%s\n' "$listed"))"
orphaned="$(comm -13 <(printf '%s\n' "$members") <(printf '%s\n' "$listed"))"

# Second half of the invariant: being listed does nothing without the marker,
# because the generic updater keys on the annotation to find the line.
unmarked=""
while IFS= read -r manifest; do
[ -n "$manifest" ] || continue
if ! grep -qE '^version = ".*" # x-release-please-version' "$ROOT/$manifest"; then
unmarked="$unmarked$manifest"$'\n'
fi
done <<< "$members"

failed=0

if [ -n "$unlisted" ]; then
{
echo "ERROR: workspace members missing from extra-files in release-please-config.json:"
printf ' %s\n' $unlisted
echo
echo "release-please will never bump these crates, so they freeze at their"
echo "current version while the rest of the workspace moves. Add each one as"
echo ' { "type": "generic", "path": "<manifest path>" }'
} >&2
failed=1
fi

if [ -n "$unmarked" ]; then
{
echo "ERROR: workspace members whose version line lacks the release-please annotation:"
printf ' %s\n' $unmarked
echo
echo 'The generic updater finds the line by its trailing `# x-release-please-version`'
echo "comment. Without it the crate is listed but never rewritten."
} >&2
failed=1
fi

if [ -n "$orphaned" ]; then
{
echo "ERROR: extra-files entries pointing at manifests that are not workspace members:"
printf ' %s\n' $orphaned
echo
echo "release-please fails the release when an extra-file path does not exist."
echo "Drop the stale entry, or restore the crate to the workspace."
} >&2
failed=1
fi

if [ "$failed" -ne 0 ]; then
exit 1
fi

echo "release versioning coverage: OK ($(printf '%s\n' "$members" | wc -l | tr -d ' ') workspace members, all annotated and listed)."