Skip to content

sui-iphw: release.md pin prose - the X.Y form and the pin-form cross-reference - #165

Merged
johnnyt merged 1 commit into
mainfrom
sui-iphw-release-md-pin-form
Sep 14, 2026
Merged

johnnyt merged 1 commit into
mainfrom
sui-iphw-release-md-pin-form

Conversation

@johnnyt

@johnnyt johnnyt commented Sep 14, 2026

Copy link
Copy Markdown
Member

Resolves sui-iphw (campaign RF047, docs-only single). Residue filed by the
RF046 conductor from PR 164's cold-1 review.

.claude/wurk/release.md forbids a current version string twice - ":23-24
carries no version string anywhere" and "the pin's current value is not
written down here" - but the pin-form section illustrated the patch-component
rule with today's literal values. The example now reads in the X.Y.1 /
~> X.Y.0 form, so it cannot go stale the way the named SHA this file
already removed once did.

The reference rule at the top said the latest prep commit beats this file
where they disagree, while the pin-form section says release commits older
than the 2026-09-13 form change are not evidence for that question. The rule
now carries a one-clause carve-out pointing at the section.

What changed

  • .claude/wurk/release.md, anchor prep leaves both pins reading: "A
    0.10.1 prep leaves both pins reading ~> 0.10.0, which already admits
    0.10.1" becomes the X.Y.1 / ~> X.Y.0 form. The article changed from
    "A" to "An" for grammar; no other word moved.
  • .claude/wurk/release.md, anchor the commit is the evidence and this file is the: one clause added - "except the pin form, which this file answers
    rather than a previous release commit (see "The README install pin"
    below)". The heading it points at is present in the same file.

Acceptance

Criterion Status Evidence
the release.md example names no current version (X.Y.1 / ~> X.Y.0 form) checked grep -nE '[0-9]+\.[0-9]+\.[0-9]+|~> *[0-9]' over the file leaves only :77 and :176, both historical claims about the past that the file's own :31-33 explicitly permits
the 'commit is the evidence' rule carries a one-clause pointer to the pin-form section checked the clause is at :21-22; the target heading ## The README install pin is at :132
docs-only, no fragment, no bump checked git diff --name-only origin/main = .claude/wurk/release.md alone; zero mix.exs lines; zero changelog.d/ files; neither also-gated path (assets/, docs/wire-format.md) touched

Gate

gate=not-run-docs-only. By this repo's commit row in CLAUDE.md: "a change
touching no Elixir code has no gate to run and may commit on review of the
diff alone". The change touches one Markdown file under .claude/wurk/ and
no path in the gate's also_gated_paths. CI still runs on this PR.

No version bump, no changelog fragment (documentation), no wire-format or
fixtures-contract change; "run" stays this repo's own noun.

Firewall

The umbrella terminology scan ran over the outbound diff and over the whole
edited file: hard=0. The positive control was constructed by injecting one
term from the firewall's hard pattern into a throwaway copy of the diff; the
scan matched that pattern on the copy and printed the count, and the copy was
deleted when the scan output was read. The scan and the push were separate
commands.

Provenance

No file outside the brief's file map was touched, and no sibling PR was
rebased over. Out of scope and reported to the conductor as rf049 residue:
docs/ops-embedding.md:25 still carries a literal {:statifier_ui, "~> 0.10.0"} - a second literal pin carrier this bead names nowhere.

The pin-form section illustrated the patch-component rule with today's
literal values, which the same file forbids twice: it "carries no version
string anywhere", and "the pin's current value is not written down here".
The example now reads in the X.Y.1 / ~> X.Y.0 form, so it stays correct
as releases accumulate and cannot go stale the way a named SHA would.

The reference rule at the top said the latest prep commit beats this file
where they disagree, while the pin-form section says release commits older
than the 2026-09-13 form change are not evidence for that question. The
rule now carries a one-clause carve-out pointing at the section.

Docs-only: no Elixir code, no also-gated path, no version bump, no
changelog fragment.
@johnnyt
johnnyt merged commit 084c70f into main Sep 14, 2026
1 check passed
@johnnyt
johnnyt deleted the sui-iphw-release-md-pin-form branch September 14, 2026 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant