Skip to content

bump-leg.py: a tracked workflow the disk spells another way is rewritten and committed under git's spelling, so a legs.yml renamed Legs.yml by case alone outside git on macOS or Windows is no longer refused as bump-leg-workflow-untracked while git status is clean, with an exit that could not clear it (#332) - #344

Merged
brettheap merged 2 commits into
mainfrom
fix/bump-leg-case-only-rename
Oct 12, 2026

Conversation

@brettheap

@brettheap brettheap commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Lane: openreposhape-3 (openRepoShape-3)
Claim: #332 (comment)

What

plan_workflows walks .github/workflows/ on disk and made a row for a file only when the walk's spelling was in git's tracked set, compared exactly. On a disk that ignores case (APFS and NTFS by default), a tracked legs.yml renamed outside git to Legs.yml is one file under both names. Git calls the root clean, and the bump refused the file as untracked, with "commit it first" as the exit when there was nothing to commit.

  • A name git does not hold is the tracked file when the filesystem says it is (_tracked_spelling). A name in git's tracked set is its own spelling, as before. Any other name is the tracked file only when exactly one tracked name in the same directory is missing from the listing and os.path.samefile resolves it to this very file. _same_file is the one place the tool asks, and the seam the tests replace.
  • A tracked name the walk lists is a file of its own (a hard link included), so it is never taken for a respelling of another file. A name that two tracked spellings both resolve to (an index holding legs.yml and LEGS.yml) is still refused as untracked: one rewrite cannot keep two index entries in step.
  • The row carries git's spelling. The dry run lists .github/workflows/legs.yml, the commit's git add and pathspec name it, and the rewrite reaches the one file through it. The disk keeps its own spelling, and nothing is renamed.

Treat it as tracked, or refuse it with a git mv remedy? I chose to treat it as tracked, because that commits no path git does not track and loses no rewrite:

  • Git's own answer for this file is "tracked and clean". A refusal would make the operator commit a rename only to satisfy the tool, on the platforms most people develop on.
  • The disk's spelling could never be committed anyway. Git matches a commit's pathspec against the index by exact spelling, whatever the disk does. Measured with core.ignorecase=true: git commit -- Legs.yml → error: pathspec 'Legs.yml' did not match any file(s) known to git. So the row has to carry git's spelling, and with git's spelling the commit holds exactly the path git tracks, rewrite included.

The filesystem is asked, not git (core.ignorecase). The issue proposed asking git which files are untracked (git ls-files -o -z, which applies core.ignorecase). I measured that direction and rejected it. core.ignorecase records the disk a clone was made on, and a copied clone keeps it. On a disk that keeps case, with the setting true, git calls a separate Legs.yml beside the tracked legs.yml neither untracked nor stageable (table below). Tried as a mutation of this fix, that direction took the second file for tracked, and the bump ended bump-leg-validators-red after the rewrite instead of being refused before it. samefile refuses it by name, before anything is written, whatever the setting says.

Why

Measured on Linux (a disk that keeps case), main c7c02fa vs this branch (8788424, the same bump-leg.py as the head):

Case main head
Tracked legs.yml renamed Legs.yml; plan_workflows with _same_file answering as a disk that ignores case raises REFUSED bump-leg-workflow-untracked: 1 workflow file(s) that git does not track (untracked or ignored) name testorg/Atlas-spec at a commit other than … / .github/workflows/Legs.yml 1 reference(s) row ('.github/workflows/legs.yml', 1)
Same rename on this disk, CLI --dry-run (core.ignorecase true or false) exit 2 REFUSED bump-leg-root-dirty / D .github/workflows/legs.yml exit 2, the same line (here the tracked name really is gone, and git says so)
A separate Legs.yml beside tracked legs.yml, core.ignorecase=true: git's view git status clean, git ls-files -o empty, git add Legs.yml is a no-op, git commit -- Legs.yml → pathspec 'Legs.yml' did not match any file(s) known to git (git's behaviour, not the tool's)
The same separate file, CLI bump exit 2 bump-leg-workflow-untracked, .github/workflows/Legs.yml 1 reference(s) the same, for a hard link too, with core.ignorecase true and false
The git ls-files -o direction (mutation), same separate file n/a exit 2 REFUSED bump-leg-validators-red after the rewrite (rejected)
An ordinary bump (tracked legs.yml naming the leg), main's and head's script over copies of one project dry-run and real output, commit message, tree 1b424ce4 identical

The case the issue is about cannot be produced on Linux, because this disk never resolves legs.yml to Legs.yml. test_a_tracked_workflow_respelled_by_case_moves_under_gits_spelling runs it for real on the macOS and Windows jobs, and those jobs on this PR are the proof.

Where the issue was wrong, or is now superseded:

Tests

tests/test_bump_leg.py, four new functions, seven cases:

  • test_a_tracked_workflow_respelled_by_case_moves_under_gits_spelling: the issue on its own disk. The tracked legs.yml is renamed Legs.yml outside git, and git status is clean. The dry run exits 0 and lists .github/workflows/legs.yml 1 reference(s). The bump exits 0 and commits exactly spec, contracts/spec-pin.yaml and .github/workflows/legs.yml. HEAD's blob holds the new @<sha> and not the old one, ls-tree holds no Legs.yml, validate-pins.py is green and the status is still clean. It runs only where a probe of the test's own temp dir finds a disk that ignores case (write case-probe, check whether CASE-PROBE exists), so it runs on the macOS and Windows jobs. It is skipped on ubuntu and here.
  • test_a_respelled_tracked_workflow_is_planned_under_gits_spelling: the rule on every disk, with _same_file replaced by a casefold comparison that stands in for a disk that ignores case. It fails on main with the issue's refusal: 1 failed, 3 passed, 1 skipped for the new tests run against main's bump-leg.py.
  • test_a_name_two_tracked_spellings_answer_to_is_refused_as_untracked: runs everywhere.
  • test_a_second_spelling_that_is_a_second_name_is_refused_whatever_git_says: a separate file and a hard link, each with core.ignorecase true and false. It runs only where the disk keeps case (a disk that ignores case cannot hold both names), so it is skipped on macOS and Windows.

Mutations, each caught (run on 8788424):

Mutation Caught by
The row carries the disk's spelling …is_planned_under_gits_spelling
Any number of matches accepted …two_tracked_spellings…
The listing check dropped the two hard-link cases
git ls-files -o asked instead …is_planned_under_gits_spelling and both true cases

Targeted set on head 7013335b09e34ddbbe63c7e9086cef6f05a25756: tests/test_bump_leg.py tests/test_repo_hygiene.py tests/test_cli_reference.py tests/test_git_output_decoding.py tests/test_stdout_encoding.py → 152 passed, 2 skipped in 358.54s. The two skips are the real-disk test (this disk keeps case) and test_stdout_encoding.py:286 (Windows only).

Composes with

Trial merges (git merge-tree --write-tree <sibling> HEAD) against every branch touching scripts/bump-leg.py or tests/test_bump_leg.py:

Branch Result
PR #264, branch fix/bump-leg-rollback-every-failure at d06546f CLEAN
issue #323, branch fix/pin-rewrite-indentation at ef8c91e CLEAN
issue #322, branch fix/trailer-non-ascii-old-git at 50986bb CLEAN
branch fix/bump-leg-unreadable-files at ac281c6 (no PR) CONFLICT in scripts/bump-leg.py. It already conflicts with origin/main by itself, because it was cut before #222. Once rebased, its _workflow_texts loop keeps this branch's listed set and _tracked_spelling call.

Left out

Closes #332

🤖 Generated with Claude Code

Summary by Sourcery

Treat filesystem-equivalent workflow spellings as their tracked Git paths while refusing ambiguous or genuinely separate files.

New Features:

  • Handle tracked workflow files whose on-disk spelling differs from Git’s spelling on case-insensitive filesystems, rewriting and committing them under the tracked path.

Bug Fixes:

  • Prevent clean case-only workflow renames from being incorrectly rejected as untracked and provide correct handling for separate files, hard links, or ambiguous duplicate index spellings.

Tests:

  • Add platform-aware coverage for case-only renames, Git spelling preservation, duplicate tracked spellings, separate files, and hard links across different core.ignorecase settings.

…ten and committed under git's spelling, so a `legs.yml` renamed `Legs.yml` by case alone outside git on macOS or Windows is no longer refused as `bump-leg-workflow-untracked` while `git status` is clean, with an exit that could not clear it (#332)

`plan_workflows` walks `.github/workflows/` on disk and made a row for a file only when the walk's spelling was in git's tracked set, compared exactly. On a disk that ignores case (APFS and NTFS by default) a tracked `legs.yml` renamed outside git to `Legs.yml` is one file under both names. Git calls the root clean, so `_ensure_root_clean` passed, and the walk's `Legs.yml` was then refused as untracked, with "commit it first" as the exit when there was nothing to commit.

- **A name git does not hold is the tracked file when the filesystem says it is.** `_tracked_spelling`: a name in git's tracked set is its own spelling, as before. Any other name is the tracked file only when exactly one tracked name in the same directory is missing from the listing and `os.path.samefile` resolves it to this very file. `_same_file` is the one place the tool asks, and the seam the tests replace. A tracked name the walk lists is a file of its own, a hard link included. A name that two tracked spellings both resolve to (an index holding `legs.yml` and `LEGS.yml`) is still refused as untracked, because one rewrite cannot keep two index entries in step.
- **The row carries git's spelling.** The dry run lists `.github/workflows/legs.yml`, the commit's `git add` and pathspec name it, and the rewrite reaches the one file through it. Git matches a commit's pathspec against the index by exact spelling whatever the disk does, so the disk's spelling could never have been committed. Measured with `core.ignorecase=true`: `git commit -- Legs.yml` refuses with "pathspec 'Legs.yml' did not match any file(s) known to git". The disk keeps its own spelling, and nothing is renamed.
- **The filesystem is asked, not `core.ignorecase`.** The issue suggested asking git which files are untracked (`git ls-files -o`). On a disk that keeps case, with `core.ignorecase=true`, git lists a separate `Legs.yml` beside the tracked `legs.yml` as neither untracked nor stageable (`git add Legs.yml` is a no-op). Tried as a mutation, that direction took the second file for tracked, and the bump ended `bump-leg-validators-red` after the rewrite instead of a refusal before it. With `samefile` it is refused by name before anything is written, whatever the setting says.
- **Tests.** Four functions in `tests/test_bump_leg.py`, seven cases. `test_a_tracked_workflow_respelled_by_case_moves_under_gits_spelling` is the issue on its own disk. A tracked `legs.yml` is renamed `Legs.yml` outside git and `git status` is clean. The dry run lists `.github/workflows/legs.yml`, and the bump exits 0 and commits exactly `spec`, the pin and `.github/workflows/legs.yml`, with the rewrite in HEAD's blob. The project's validator is green and the status is still clean. It runs only where a probe of the test's temporary directory finds a disk that ignores case (the macOS and Windows jobs), and is skipped on one that keeps it. `test_a_respelled_tracked_workflow_is_planned_under_gits_spelling` is the rule on every disk, with `_same_file` answering as a disk that ignores case would. It fails on main with the issue's refusal. `test_a_name_two_tracked_spellings_answer_to_is_refused_as_untracked` runs everywhere. `test_a_second_spelling_that_is_a_second_name_is_refused_whatever_git_says` is parametrized over a separate file and a hard link, each with `core.ignorecase` true and false, and runs only where the disk keeps case. Four mutations of the fix are each caught by at least one of these tests: the row carrying the disk's spelling, any number of matches accepted, the listing check dropped, and asking `git ls-files -o`.
- **Unchanged:** main's and this branch's `bump-leg.py` were each run over a copy of one project, on an ordinary bump (a tracked `legs.yml` naming the leg). Both print the same dry-run and real output and write the same commit message and the same tree. The refusal's id, text and exits are unchanged. `--help` is unchanged, so `docs/cli.md` is too, and README's "an untracked or ignored workflow file it would rewrite" stays true.
- **Left out:** an index that already holds two spellings of one workflow, on a disk that ignores case and lists one of them exactly, still has that one rewritten and committed while the other keeps its old `@<sha>` in the tree. That defect predates #222. A name APFS stores in another Unicode normalization form than the index falls under the same `samefile` rule, but is not tested here.

Closes #332

Lane: openreposhape-3 (openRepoShape-3)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Oct 12, 2026

Copy link
Copy Markdown

Sorry @brettheap, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 10 hours and 48 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@brettheap

Copy link
Copy Markdown
Contributor Author

(lane openRepoShape-3, 2026-10-12T11:54:02Z) @codex review

@sourcery-ai

sourcery-ai Bot commented Oct 12, 2026

Copy link
Copy Markdown

Reviewer's Guide

The PR makes workflow planning filesystem-aware so a tracked file renamed by case alone outside Git is rewritten and committed under Git’s canonical spelling, while ambiguous tracked entries and distinct files remain refused as untracked. Tests cover real case-insensitive filesystems, simulated matching, hard links, and core.ignorecase edge cases.

Sequence diagram for case-respelled workflow bump

sequenceDiagram
    participant Planner as plan_workflows
    participant FS as Filesystem
    participant Git as Git index
    participant Commit as Commit operation

    Planner->>Git: _tracked_workflows
    Git-->>Planner: legs.yml
    Planner->>FS: iterdir workflows
    FS-->>Planner: Legs.yml
    Planner->>FS: _same_file(legs.yml, Legs.yml)
    FS-->>Planner: true
    Planner->>Planner: _tracked_spelling
    Planner->>FS: Read Legs.yml and rewrite contents
    Planner->>Commit: Use .github/workflows/legs.yml pathspec
    Commit-->>Planner: Commit tracked spelling and rewritten blob
Loading

State diagram for workflow file resolution

stateDiagram-v2
    [*] --> ListedTracked
    [*] --> UnlistedCandidate
    ListedTracked --> Rewrite: tracked spelling is listed
    UnlistedCandidate --> ResolveMissing: find missing tracked names
    ResolveMissing --> Rewrite: exactly one _same_file match
    ResolveMissing --> Refused: zero or multiple matches
    Rewrite --> Committed: use Git spelling
    Refused --> [*]
    Committed --> [*]
Loading

Flow diagram for case-aware workflow tracking

flowchart TD
    A[Workflow file from directory walk] --> B{Git spelling listed?}
    B -->|Yes| C[Use the listed Git spelling]
    B -->|No| D[Find missing tracked names in same directory]
    D --> E{Exactly one name resolves via _same_file?}
    E -->|Yes| F[Use the missing tracked spelling]
    E -->|No| G[Refuse as bump-leg-workflow-untracked]
    C --> H[Rewrite workflow]
    F --> H
    H --> I[Commit using Git spelling]
Loading

File-Level Changes

Change Details Files
Resolve case-only workflow respellings against Git’s tracked spelling using filesystem identity.
  • Added _same_file as the filesystem identity seam.
  • Added _tracked_spelling to accept a uniquely matching tracked path when the directory walk uses a different spelling.
  • Require exactly one missing tracked spelling and reject ambiguous index entries or separately listed files.
  • Preserve Git’s spelling in plans, dry-run output, rewrites, and commit pathspecs.
scripts/bump-leg.py
Add cross-platform and edge-case coverage for workflow spelling resolution.
  • Test the real case-insensitive-disk scenario on macOS and Windows, including dry-run, commit contents, validation, and clean status.
  • Test the resolution rule on all platforms through a _same_file replacement.
  • Verify ambiguous tracked spellings, separate files, and hard links are refused regardless of core.ignorecase.
  • Probe filesystem behavior rather than assuming the operating system’s case sensitivity.
tests/test_bump_leg.py

Assessment against linked issues

Issue Objective Addressed Explanation
#332 Make plan_workflows recognize a workflow whose on-disk spelling differs from Git's tracked spelling by case alone on a case-insensitive filesystem, instead of classifying it as untracked. ✅
#332 Plan and commit the rewrite using Git's tracked path spelling while operating on the same on-disk file, so the case-only rename is successfully bumped without requiring a nonexistent preliminary commit. ✅
#332 Preserve safe refusal behavior for genuinely separate files, hard links, or ambiguous cases involving multiple tracked spellings, and add regression coverage for these scenarios. ✅

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-12T12:00:10.334018Z 7013335 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: 7013335b09

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@sonarqubecloud

Copy link
Copy Markdown

@brettheap
brettheap merged commit a2cb7d3 into main Oct 12, 2026
7 of 8 checks passed
@brettheap
brettheap deleted the fix/bump-leg-case-only-rename branch October 12, 2026 13:40
brettheap added a commit that referenced this pull request Oct 12, 2026
…and #296 merge with no conflict, and #190's `remote_key` test in tests/test_shape_doctor.py stands beside #296's `gh` guard rows

Main since f795cf7: a2cb7d3 (#332 via #344, bump-leg.py) and ab623dd
(#296 via #349, a session `gh` guard in tests/conftest.py, with
tests/gh_guard.py and tests/test_gh_guard.py). Neither touches
adopt-project.py or scripts/repo_shape.py.

No conflict hunk. The one file changed on both sides is
tests/test_shape_doctor.py: #190's
`test_a_port_and_githubs_ssh_host_are_not_part_of_a_remotes_key` (32
lines) and #296's rows (109 lines). Each side's +/- lines there are
identical before and after the merge. Every other file is one side's blob.
The merge's diff against main is #190's six files.

Lane: openreposhape-1 (openRepoShape-1)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 12, 2026
…344 landed in bump-leg.py

Lane 3's #344 landed on main as a2cb7d3 (closes #332) and changed
scripts/bump-leg.py in the same two places as this branch, so the merge
conflicted in that one file, in two add/add regions. No other file conflicted.
Both sides are kept in each, because the two changes add different things and
neither replaces the other:

1. The helpers before `plan_workflows`. This branch adds `_not_utf8`,
   `_leg_pin_text` and `_workflow_texts` (#289); main adds `_same_file` and
   `_tracked_spelling` (#332). All five stay: ours first, then theirs.

2. The last paragraph of `plan_workflows`'s docstring. Main's "A TRACKED FILE
   THE DISK SPELLS ANOTHER WAY IS STILL TRACKED (#332)" paragraph stays whole,
   and this branch's one sentence on a file that is not UTF-8 follows it.

Git merged the body of `plan_workflows` with no conflict, and the composition
is the one both changes need: the loop reads
`for path, text in _workflow_texts(root, workflows)`, so every workflow is read
as UTF-8 before anything is written and a file that is not UTF-8 is refused by
name whatever its spelling on disk; each row is then spelled through
`_tracked_spelling(root, path, tracked, listed)`, so a tracked file respelled
by case is still planned under git's spelling.

Lane: openreposhape-2 (openRepoShape-2)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
brettheap pushed a commit that referenced this pull request Oct 12, 2026
…b623dd) into fix/adopt-pin-writes-pin-file: adopt's pins sit on a validate-pins.py that composes #312's PRODUCT=PATH reading with #275's neutral-pin-source-collides, byte-identical to Q's, and on main through #270, #312, #317, #344 and #349 with no conflict

The merge is clean. templates/assembly-root/scripts/validate-pins.py,
scripts/repo_shape.py and tests/test_pin_source_env_collisions.py are
byte-identical to fix/pin-source-env-collisions 34dbd86 (blob 54d8ac7 for the
validator), so adopt's branch does not diverge from #275's there. adopt-project.py,
scripts/shape_materialize.py, docs/cli.md and tests/test_git_output_decoding.py
auto-merged over main's #270 (f795cf7, `unwritable_reason`), #312, #317, #344 and
#349 (the session `gh` guard).

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 12, 2026
…ine marked untracked or ignored when git does not track it, and the remediation tells a tracked file's operator to commit it and an untracked one's not to, so no operator commits a draft onto the bump branch to clear the refusal (#289)

The review of #352 (107242d) found that the `bump-leg-workflow-unreadable`
remediation ended "re-save every file named as UTF-8 ... commit it, and run
the same command again" for every file it named. That is true of a file git
tracks and false of one it does not: re-saving an untracked draft is enough
(the bump then goes through and the draft is not in the lockstep commit),
committing it puts a draft workflow on the bump branch, which #207's
`bump-leg-workflow-untracked` refusal exists to prevent, and `git add`
refuses an ignored file outright.

`_workflow_texts` now takes `tracked` and `listed`, the two sets
`plan_workflows` already holds before it calls it, and asks
`_tracked_spelling` of each file it refuses. A line git does not track ends
`(untracked or ignored)`, and the remediation gives each kind its own advice:
"Commit each file git tracks." for a tracked one, and "needs no commit, only
the re-save" with the move-it-out alternative for the others. The question is
asked only of a file already refused and reads no file, so every read still
comes before anything is written, `--dry-run` included. `_tracked_spelling`
is the question #344 settled, so a tracked file the disk spells another way
is not marked untracked.

Tests, in tests/test_bump_leg_unreadable.py (19, from 13):
- an untracked and an ignored draft holding `# caf\xe9`, bump and `--dry-run`
  (4): exit 2, the line marked, the remediation without "commit it", then the
  file re-saved as UTF-8 and still untracked bumps and is not in the commit;
  at 107242d these fail on the unmarked line and on "commit it";
- an unreadable tracked file and an unreadable untracked one in one refusal (1);
- a tracked `legs.yml` holding a Latin-1 byte, renamed outside git to
  `Legs.yml`, through #344's `_same_file` seam so it runs on every OS (1):
  refused `bump-leg-workflow-unreadable` under the disk's spelling, not
  marked untracked, bytes unchanged. This pins the composition the review
  confirmed by probe; it passes at 107242d.

Mutants of the marking, each killed: an unreadable untracked file skipped
(the one that survived the review), every line marked tracked, every line
marked untracked, the exact-spelling comparison, and each half of the advice
dropped.

Lane: openreposhape-2 (openRepoShape-2)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
brettheap added a commit that referenced this pull request Oct 12, 2026
…plan-unwritable-value` joins `_entry_findings` after this branch's `plan-root-symlink`, and both are refused by `execute` before any leg

origin/main moved 8cdca5e -> a2cb7d3 while this branch's runs were going.
f795cf7 changes adopt-project.py and scripts/shape_materialize.py, so main
is merged once more, by sha, at its tip:
- db19187 (#300 via #317), scripts/family.py and the template's
  scripts/validate-family.py: `add` refuses `member-path-registered`
  when another `.gitmodules` section already names the mount path;
- f795cf7 (#255 via #270), adopt-project.py and
  scripts/shape_materialize.py: `unwritable_reason` asks whether a file
  can hold a value `execute` writes; `plan` refuses
  `adopt-unwritable-value`, `check` reports `plan-unwritable-value`
  through `_entry_findings`, and `execute` refuses an unwritable local
  clone URL right after `_repository_urls`;
- a2cb7d3 (#332 via #344), scripts/bump-leg.py: a tracked workflow the
  disk spells another way by case is rewritten under git's spelling.

scripts/shape_materialize.py, scripts/family.py, scripts/bump-leg.py and
the tests merge with no conflict. adopt-project.py conflicts in two hunks
of `_entry_findings`, where both sides added to the same end of the one
list:
1. The docstring. This branch added "then each symlink the plan keeps in
   the root that a shape file cannot be written through (#178, #183)",
   main "then each value `execute` writes into a file that no file can
   hold (#255)". Both are kept, in the list's order.
2. The return. Both are kept: the symlink findings stay after the
   source's own submodules, and #255's value findings come after them,
   with #255's remediation after the others. The symlinks are read out
   of the source's tree, as the submodules before them are; the values
   are the plan's own fields. A plan with neither prints what it printed
   before.

`execute` now refuses, before `_create_leg_remotes`: an unwritable clone
URL (#255), then `_refuse_what_check_finds` (this list), then this
branch's `core.symlinks` probe. That order merged with no conflict.

Checked on the merged tree:
- adopt-project.py and scripts/shape_materialize.py are byte for byte
  the ones a scratch merge of f795cf7 alone produced, on which
  tests/test_adopt_template_values.py, tests/test_adopt_root_symlinks.py
  and main's two tests of `_verify`'s sentence passed (340).
- AST (fin183g/names.py, base 8cdca5e): no top-level name is bound twice
  in adopt-project.py, scaffold-project.py, scripts/repo_shape.py or
  scripts/shape_materialize.py, and none is loaded but bound nowhere.
- Both sides intact (fin183g/sides_intact.py): the only lines that differ
  from either side's own change are the two hunks above.
- F1's sentences (`TOO_MANY_SYMLINKS` in `_through` and in the
  materializer's `_link_parts`, and the one line in `_verify`'s
  `_resolve`), F2's `_absolute_here` and F3's `CLONE_GIT` are unchanged.

Lane: openreposhape-1 (openRepoShape-1)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 12, 2026
brettheap added a commit that referenced this pull request Oct 13, 2026
… writes its pin file as the scaffold does, so an adopted root passes `validate-pins.py` (#273); a `--pin-source` that cannot answer is `pin-source-unreadable` (#339) (#508)

**Brought up to date after #409 squash-landed** by merging origin/main (9736424, #409's squash) as f9ed46f. Its `scaffold-project.py` conflict was resolved to this branch's side once `git diff b70a07d 9736424 -- scaffold-project.py` (#409's final head against its squash) came out empty. So the file is the one tested on this branch plus main's own later changes to it, and holds nothing of #409's; details below.

This branch carries #275's adopt half. It was built on `fix/pin-source-env-collisions`, PR #409 (#275's scaffold half and its fix round), merged at 6494714 as 583f647, over the earlier 5690235 (34dbd86). After 6494714, #409 only merged main, five times, up to its final head b70a07d, and none of those merges has a hand edit (`git show --remerge-diff` is empty for each). Adopt's refusal of two products that share a source variable goes through #409's function, so this branch lands after #409. It was never rebased.

`git diff b70a07d 9736424` is empty for each file #409 touched: `scaffold-project.py`, `scripts/repo_shape.py`, `templates/assembly-root/scripts/validate-pins.py` and `tests/test_pin_source_env_collisions.py`. What f9ed46f resolves, four files with one hunk each:
- **`scaffold-project.py`.**
  - The conflict hunk is main's block from `PIN_COLLISION_REMEDIATION` through `_pin_collision_remediation`, which #409's squash edits: it adds `PIN_VARIABLE_REMEDIATION`, `_colliding_pin_variables` and `_pin_collision_remediation` and changes `_refuse_colliding_pins`. This branch moved all of that to `scripts/shape_materialize.py`. The hunk takes this branch's side. (The merge commit's message says "re-adds"; this is the exact account.)
  - #409's auto-merged import of `PIN_SOURCE_ENV_PREFIX, pin_source_env_collisions` is dropped, because nothing in the file uses either name any more.
  - It is not `git checkout --ours` of the whole file. Main changed the file beyond #409 since this branch last merged it: #355's `--tracking-branch` check (6c2a371) and a73b4e9's `RULESET_HINT`. Those lines stay.
  - The result is the file `git merge-tree` gives for this branch with main before the squash (518010b). Its diff from the file tested here has the same patch-id as main's own 3ef059c..518010b change to it.
- **`templates/assembly-root/scripts/validate-pins.py`.** Main's side, which is #409's final blob, with main's #359 workflow reader in it. This branch had no change of its own to the file beyond #409.
- **`adopt-project.py`, `_commit_the_split`.**
  - Main: #445 wraps the function in its late-failure `try`, and #394 builds an `append` with the plan's submodule record.
  - This branch: its only edits there were a comment and `neutral_pins=_recorded_pins(plan)` on the materializer call.
  - Both now sit on main's call inside the `try`: `append=append, neutral_pins=_recorded_pins(plan)`.
- **`docs/cli.md`.** It is regenerated with `scripts/render-cli-reference.py`, and `--check` is ok. It differs from main's only in the `--pin`, `--pin-owner` and `--pin-source` help of `adopt-project.py plan`.

`scripts/repo_shape.py`, `templates/assembly-root/scripts/validate-pins.py` and `tests/test_pin_source_env_collisions.py` are main's blobs, which are #409's: this branch adds nothing to them. Nothing of #409 is lost. Its scaffold behaviour is `shape_materialize.refuse_colliding_pins` and `pin_variable_collisions`, keyed by #409's `pin_product_key`.

**73d65c6, after the merge.**
- **The change.** `_read_pins` reads `plan.get("pins")` where it read `plan.data.get("pins")`.
- **Why.** #445's `tests/test_adopt_late_failure.py` hands `_commit_the_split` a `SplitPlan` as its plan, a `dict` that adds `entries`. On f9ed46f, three of its tests stopped at "committing the split" with `AttributeError: 'SplitPlan' object has no attribute 'data'` (3 failed, 83 passed in that file).
- **Nothing else changes.** `Plan.get` with no default returns `plan.data.get(key)` exactly, so a loaded plan reads as before.

`adopt-project.py plan --pin` took a NAME only (`--pin openGlass`) and refused a trailing `@<commit>`. `plan`, `check` and `execute` each exited 0, and `execute` printed `adoption verified`. The manifest then listed the name in `neutral_product_pins:` with no `contracts/<product>-pin.yaml` beside it, and on its first run the adopted root's own `validate-pins.py` refused it as `neutral-pin-missing`.

#273's table, reproduced on c7c02fa with the issue's own commands (local bare remotes, and a stub `gh` that exits 97):

| `--pin` | c7c02fa | this branch |
|---|---|---|
| `openGlass` | `execute` exit 0, `- openGlass`; clone's `validate-pins.py` exit 2 `neutral-pin-missing` | `plan` exit 2 `pin-malformed`, with the scaffold's remediation (`--pin openGlass@<40 hex>`); no plan is written |
| `opensoft/openGlass` | exit 0, `- opensoft/openGlass`; exit 2 `neutral-pin-missing` for `contracts/opensoft/openglass-pin.yaml` | `plan` exit 2 `pin-malformed` |
| `spec` | exit 0; `validate-pins.py` exit 0, reading the leg's `contracts/spec-pin.yaml` as the neutral pin | `spec@<sha>` is `adopt-pin-collides` at `plan` |
| `shape` | exit 0; `contracts/shape-pin.yaml` read as the neutral pin | `shape@<sha>` is `adopt-pin-collides` at `plan` |
| `openGlass@<sha>`, `opensoft/openGlass@<sha>` | `plan` exit 2 `adopt-pin-malformed` | `plan`, `check` and `execute` exit 0, and `gh` is called 0 times. `contracts/openglass-pin.yaml` is written and the manifest lists `- openGlass`. In the clone, `validate-manifest.py` exits 0, and `validate-pins.py` exits 0 with `openGlass: pin commit … digest recomputes` |

Brett ruled for decision 1's first option ("go with your recommendation on #273"): adopt takes the scaffold's pin and writes the scaffold's pin file. That reverses the NAME-only `--pin` from #6, and the comment that described it is replaced with the new contract.

- **One implementation.** The scaffold's pin code moved into `scripts/shape_materialize.py`, next to `neutral_pin_path` and the materializer that writes the file. What moved:
  - `PIN_ARG_RE`, `parse_pin`, `pin_digest_from_source` and `pin_digest_from_gh`;
  - `declared_pin_values`, `declared_pin_products` and `PIN_COLLISION_REMEDIATION` (in #309's wording);
  - from #275's branch, `PIN_VARIABLE_REMEDIATION` and the variable check;
  - `_refuse_colliding_pins`, split into the pure `pin_collisions` and `pin_variable_collisions`, and `refuse_colliding_pins(refusal=...)`, which raises one refusal for both.

  The code did not move verbatim. `_refuse_colliding_pins` became the three functions above; `pin_digest_from_source` was rewritten for #339 (below); and fix round 1 changed three of them (below): `pin_variable_collisions` keys each pin by #275's `pin_product_key`, `pin_digest_from_source` spells a path that is not printable, and `pin_digest_from_gh` refuses a missing `gh`. The scaffold's behaviour is otherwise unchanged. `scaffold-project.py` imports what it calls under its old names. Lane 5's review ran 34 scaffold cases (every pin refusal, the `gh` stub's four modes, dry and real successes) on 34dbd86 and on this branch at 7a94b6b. rc, stdout, stderr, the `gh` log and the files made were identical, apart from the shape's own commit and digest and #339's row. Its pin tests and #275's pass as they are. `tests/test_git_output_decoding.py`'s exemption for `pin_digest_from_gh` follows the function to its new file.
- **`plan`.** `--pin`, `--pin-owner` and `--pin-source` mean what they mean for the scaffold. `plan` reads the digest from `--pin-source` or `gh api`, and records product, repository, commit, digest and `digest_source` in the plan, so `check` and `execute` read no network for a pin. `plan` refuses:
  - a name with no `@<commit>`, as `pin-malformed`. That includes an empty `--pin ''`, which adopt used to drop and now refuses, as the scaffold always has;
  - `spec`, `code` and `shape`, in any case, as `adopt-pin-collides` (#273 decision 4), in the scaffold's sentence and remediation (#241, #309);
  - one product given twice, the same way, whether it is a repeat or two names that share one file (decision 5);
  - two products that one `SHAPE_PIN_SOURCE_<PRODUCT>` names, such as `open-glass` and `open_glass`, the same way, through #275's check;
  - a leg path over a pin's file, as `adopt-leg-path-collides`;
  - a `--pin-source` path that `check` would refuse in `digest_source:` (fix round 1), as `adopt-unwritable-value`. It is asked only when a `--pin` records the path;
  - with no `gh` on PATH and no `--pin-source`, `gh-not-found` (fix round 1).
- **`check` and `execute`.** These are new `check` findings, and `execute` refuses each one before any leg exists. They come from `_leg_findings`, the list `check` and `_refuse_what_check_finds` share:
  - `plan-pin-unrecorded`: a name alone (an old plan's `pins: [openGlass]`, or a hand edit), or an entry missing its commit or digest;
  - `plan-pin-malformed`;
  - `plan-pin-collides`, which covers two pins at one file, a pin at a file the shape writes, and two products that share one source variable;
  - `plan-root-holds-pin`: a source path kept in the root at the pin's file. The materializer would write the shape's pin beside it under `shape/`, and `validate-pins.py` would read the source's file instead.

  How each finding ends:
  - `plan-pin-unrecorded` and `plan-pin-malformed` end with the `plan --pin <product>@<40 hex commit>` that records the pin whole.
  - `plan-pin-collides` ends with re-running `plan` with each product once, or, for two products that share a source variable, with one product of each such group.
  - `plan-root-holds-pin` ends with the kept path's own remedy: send that entry to a leg, `drop` it, or rename it in the source and re-run `plan`.

  A leg moved over a pin's file in the plan is `plan-leg-path-collides`.
- **Also part of #386: its `pins:` row.** A hand-edited `pins:` that is not a list (a name such as `pins: openGlass`, a number, a mapping, a quoted string) is now `plan-pin-malformed` in `check` (`` `pins:` is 'openGlass', not a list of pins ``), and `execute` refuses it before any leg exists.
  - Where: `_read_pins` in `adopt-project.py`; the test row is `plan-pin-malformed-not-a-list` in `tests/test_adopt_pins.py`.
  - Before: on main, `check` said `plan ok` for the name, the mapping and the string, and gave a traceback for the number (reproduced by lane 5's review on cb7063f). #386 records that `execute` then wrote the name as eight one-letter pins.
  - Not fixed here: #386's other keys, `allow_empty_legs:`, `paths:`, `legs:` and `source:`, so #386 stays open. Lane 2's #435 takes all of #386, `pins:` included, and its `pins:` rule keeps only text items where this branch writes mappings; whichever lands second reconciles them (#435 (comment), and "Where the meaning meets" below).
- **`execute`.** It writes each pin through `materialize_assembly_root(neutral_pins=...)`. The manifest lists the product with the owner stripped (decision 3), so the entry and the file agree.
- **Docs.** `--help` is updated and `docs/cli.md` regenerated (`render-cli-reference.py --check` ok).

`pin_digest_from_source` caught only `Refusal`. A directory that is no clone is git's own failure, so it was always `pin-source-unreadable`, exit 2. A path `subprocess.run` cannot enter never reaches git: it is a `FileNotFoundError`, `NotADirectoryError` or `PermissionError` out of `cwd=`, and nothing caught it. `scaffold-project.py --pin ... --pin-source <that>` ended `--dry-run` and the real run alike in a traceback, exit 1. Since the move above, `adopt-project.py plan --pin` reads its digest through the same function and ended the same way. Both reach it through `declared_pin_values`, and `check` and `execute` read no source, so that call is the only reader.

The issue's table, run on ab623dd for the scaffold and on d806e8f for `adopt-project.py plan` (adopt has no `--pin-source` on ab623dd), then on this head. `gh` is a stub that logs and exits 97, with `GH_TOKEN` bogus and an empty `GH_CONFIG_DIR`; it was called 0 times in every run:

| `--pin-source` | before | this branch |
|---|---|---|
| a directory that is not a clone | `pin-source-unreadable`, exit 2 | unchanged |
| a path that does not exist | `FileNotFoundError` traceback, exit 1 | `pin-source-unreadable`, exit 2: `<path> could not answer for opensoft/openGlass @ <40 hex>: no such directory` |
| a file | `NotADirectoryError`, exit 1 | exit 2, `... it is a file, not a directory` |
| under a parent this user cannot enter | `PermissionError`, exit 1 | exit 2, `... Permission denied` |
| a symlink loop (not in the issue) | `RuntimeError` out of `Path.resolve()` on 3.12, exit 1 | exit 2, `... Too many levels of symbolic links` |

The real run and `--dry-run` give the same stdout and stderr, and nothing exists afterwards (no remote directory, no work directory; for adopt, no plan file).

What changed, in `scripts/shape_materialize.py` only:
- `pin_digest_from_source` catches `OSError` as well as `Refusal` and raises the existing `pin-source-unreadable` with its remediation unchanged. The message names the path and the reason.
- `stat()` judges the source inside the guard, as #312 does in `validate-pins.py`, and the sentences are that file's: a missing path, or one beneath a file, is "no such directory"; a file is "it is a file, not a directory"; any other `OSError`, from `stat()` or from git's `cwd=`, is the system's own reason (`strerror`). It is not `exists()`/`is_dir()`, which before 3.14 swallow only a missing path. A source `stat()` can read but `cwd=` cannot enter, a directory with no search bit, fails in `tree_digest` and the same guard answers it.
- `declared_pin_values` resolves the path through a guarded `_resolved_pin_source`. `Path.resolve()` raises a `RuntimeError` on a symlink loop before 3.13 (an `OSError` since), before the digest was asked for. As typed, `stat()` meets the loop and says so.
- A source that answers is read exactly as before: a relative path resolves against the working directory, a symlink to a clone is followed, `digest_source` reads `local-clone (<path as typed>)`, and the digest is `tree_digest`'s.

`tests/test_pin_source_unreadable.py` (46 tests in the #339 commit; fix round 1 adds 17 for S1 and moves one, below) runs each case through `scaffold-project.py --dry-run`, its real run and `adopt-project.py plan`: missing, a file, beneath a file, relative and missing, a parent and a source with no search bit (skipped on Windows and as root, by a mark, so before any fixture builds a directory), a 300-character name, a symlink loop (skipped on Windows) and a directory that is no clone. Each asserts exit 2, the refusal naming the path and the reason, its remediation, no traceback and nothing created. It also holds `--dry-run` and the real run to the same stdout and stderr, checks the path is printed escaped under an ASCII stderr and as a surrogate when it is not UTF-8, and checks that a relative source and a symlink to a clone read as before. The session `gh` guard fails any test whose run called `gh`.

origin/main ab623dd reached this branch through implQ's branch: 34dbd86 is a30091f merged with ab623dd. One file conflicted there, `templates/assembly-root/scripts/validate-pins.py`, in seven hunks, because #312 (8cdca5e) replaced `keyed_sources` and `default_source` with `PinSources` and #275 added `env_shared` and `shared`. #312's blob is the same at its PR head, at the squash and at ab623dd, so it landed the file implQ resolved against. The resolution keeps #312's side in all seven and adds #275's on top:

| # | hunk | resolution |
|---|---|---|
| 1 | `resolve_neutral_pin_source` signature | #312's `sources: PinSources` and 3-tuple return, plus #275's `env_shared: bool = False` |
| 2 | its docstring tail | #312's `Returns (path, how, typed)` text, plus #275's "Rule 2 is skipped when `env_shared`" paragraph |
| 3 | `_recompute_neutral_pin_digest` signature | #312's `sources`, plus #275's `shared: frozenset[str]` after `report` |
| 4 | the `resolve_neutral_pin_source(...)` call inside it | #312's 3-tuple unpack, plus `env_shared = product.casefold() in shared` and the extra argument |
| 5 | `_check_one_neutral_product_pin` signature | #312's `sources`, plus #275's `shared` |
| 6 | its call of `_recompute_neutral_pin_digest` | `sources, report, shared` |
| 7 | `_check_neutral_product_pins` docstring and body | #312's `PinSources(...)` and `_note_unused_pin_sources`, plus #275's paragraph, `_report_pin_source_collisions(products, report)` and `shared = frozenset(pin_source_env_shared(products))` |

This branch's own merge of 34dbd86 (5690235) had no conflict, and neither had its merge of #409's fix round, 6494714 (583f647). That fix round made `neutral-pin-source-collides` a note and keyed "one product" by `repo_shape.pin_product_key`. At 421e4e5, `templates/assembly-root/scripts/validate-pins.py`, `scripts/repo_shape.py` and `tests/test_pin_source_env_collisions.py` were byte-identical to the tree `git merge-tree` gives for 6494714 with origin/main 3ef059c (blobs 5604007, 091966b, 5220787), so this branch added nothing to those three files beyond #409. The 34dbd86 merge brought in #335, #312, #317, #270 (f795cf7), #344 and #349 with no conflict. Earlier merges of origin/main (87373a6, for #309's reworded constant, and e43fa95) are unchanged.

Fix round 1 merged origin/main three more times:
- **cd1fc79 (2bcfa69).** It brought #245, #351, #350, #345, #372, #371, #354, #380, #377 and the rest since ab623dd, with no conflict.
- **45e01f4 (4098b61).** It brought #396's `tests/test_agents_md_codes.py`. That test finds `scaffold-pin-collides` as a string constant of `scripts/shape_materialize.py`, which `SHIPPED` lists.
- **3ef059c (421e4e5), #314.** One conflict, one hunk in `adopt-project.py`. This branch's `_refuse_an_unrecordable_pin_source` and #314's section "The project must be able to hold what `execute` writes into it (#261)" were added at the same place; both are kept. Where the two meet, lane 5's earlier recipe applies:
  - `_flag_plan` builds each pin as the `PIN_FIELDS` mapping `plan` writes, not `list(pins)` of products. So the plan `plan` asks the validator about is the plan it writes.
  - #314's `test_plan_asks_what_check_asks_of_the_same_keys` plans `--pin openGlass@<commit> --pin-source <stand-in>` where it planned the name alone, which `plan` now refuses.

Then f9ed46f, after #409 squash-landed, and 73d65c6 after it (top of this description).

On the merged tree exactly one test failed: `tests/test_adopt_template_values.py::test_check_finds_and_execute_refuses_a_hand_edited_value[pins-surrogate]`. It plans, then hand-edits the plan to `pins: ["openX\ud800"]`, a name-only pin with a lone surrogate. Before this branch the refusal's headline was `REFUSED plan-unwritable-value`. A name-only pin in a plan is now `plan-pin-unrecorded` (#273), so `check` has a second, independent finding for that very plan, and the headline is the first finding's:

```
REFUSED plan-pin-unrecorded: 2 finding(s) ...
FINDING plan-pin-unrecorded: `pins:` entry 1, 'openX\ud800', is a name with no commit and no digest ...
FINDING plan-unwritable-value: a `pins:` item is 'openX\ud800', which `execute` writes into the assembly root's `project.yaml`, and it holds a lone surrogate ...
```

Nothing about #270's contract changed. The lone surrogate is still found as `plan-unwritable-value`, listed under the refusal, and `execute` still refuses before any leg exists. `check` builds `_leg_findings`, where `_pin_findings` sits, before it calls `_value_findings`, so the pin finding comes first. d806e8f changes one assertion for that row, `pins` only: the headline is `REFUSED plan-pin-unrecorded: ` where it was `PLAN_REFUSED`. The other 15 rows and the finding assertions, including the `plan-unwritable-value` line, are untouched.

Lane 5's review of 7a94b6b found 3 should-fix and 5 nits. Each is answered here:
- **#409's `pin_product_key` (review N1).** The merge of #409's fix round could not carry it, because this branch had moved the function that used it out of `scaffold-project.py`. `pin_variable_collisions` now keys each pin by that function, where it casefolded. `openß` and `openss` are two pin files and one `SHAPE_PIN_SOURCE_OPENSS`, and a casefold named each of the two pins twice. No `--pin` or recorded `pins:` entry `PIN_ARG_RE` admits can spell either, so the test asks the function directly. `refuse_colliding_pins`' docstring now says, in #409's words, that the root's `validate-pins.py` only notes such a pair.
- **S1, a `--pin-source` path that is not printable.** `pin_digest_from_source` names the path as typed unless it is not printable (`str.isprintable`), and then as Python's `repr` spells it (`shown_source`). That covers the refusal's head and git's own reason, which names the directory it ran in. Printed raw, an ESC reached the terminal, and a line break or a carriage return began a line of the path's choosing, a forged `REFUSED` line among them, from the scaffold and from adopt. The traceback #339 replaced had shown a `repr`. A printable path is named byte for byte as before.
- **S2, no `gh` on PATH.** `pin_digest_from_gh` refuses as `gh-not-found`, exit 2, as `repo_shape.tree_digest_from_gh` names it, and offers `--pin-source`. It was a `FileNotFoundError` traceback, exit 1, from the scaffold and, new with this branch, from `adopt-project.py plan --pin`.
- **S3, a hand-edited `commit:` or `tree_sha256:`.** The lane's decision is to accept it and document it (option (c)); no behaviour changed. A pair that disagrees passes `check` and `execute` (`adoption verified`), because neither reads a network for a pin, by design. The adopted root's own `validate-pins.py` then exits 1 with `neutral-pin-digest-mismatch` wherever it can read the product. `check` now says so once, after the pins it will write: "each pin as `plan` read it, not read again here: the root's own `validate-pins.py` recomputes its digest wherever it can read the product". Options (a), `execute` recomputes before it creates the legs, and (b), `check` recomputes from a clone still on the machine, are filed as #449.
- **N2, a `--pin-source` that `plan` cannot record.** `plan` asks `check`'s question (`one_printable_line`) of the path it records in each pin's `digest_source:`, before any digest is read. It refuses one that fails as `adopt-unwritable-value`, in #270's words (`unwritable_reason`), or as "an invisible formatting character" where those name nothing. Before, it was planned, exit 0, and printed raw in the report. `check` then refused it as `plan-pin-malformed` and said to re-run the same `plan`. The report's `pin` line and `check`'s `write` line now spell the digest's source with `_shown`. The scaffold half is pre-existing (a line break in the path is written into the pin file; a byte that is not UTF-8 dies after all three repositories exist) and is filed as #450.
- **N3, six hunks no test guarded.** Each now has a test that fails when it alone is reverted:
  - the two name guards (a `pins:` name holding an ESC and a forged line);
  - the lower-casing of the commit and the digest (an upper-cased hand edit);
  - the `digest_source` printability check;
  - the not-text check (`commit: 1234567` unquoted);
  - the gitlink filter (a submodule kept where the pin is written is `plan-submodule-root` alone).
- **N4.** This body.
- **N5, #339's third decision.** A `--pin-source` that nothing reads is still silent, now in adopt too. This PR does not decide it. #451, filed, lays out refuse, note and leave, so closing #339 loses nothing.

Lane 5's second review, of 421e4e5, found no blocking item, 2 should-fix items and 3 nits. The two should-fix items are this body: the landing after #409 (above) and #386 (above). The code needed no change for them. f63d1ed adds two tests and no code:
- **n1. `plan` asks nothing of a `--pin-source` no `--pin` records.** With the `args.pin and` guard dropped, such a path holding an ESC or a zero-width joiner was refused in a sentence naming no file ("`execute` writes into , and ..."), and every test still passed. `test_a_pin_source_no_pin_records_is_not_asked_about` holds the plan to exit 0 and `pins: []`, with the path named nowhere in the plan or the report. The ESC row is POSIX-only by the file's `POSIX_NAMES` mark; the zero-width joiner row runs everywhere. It holds #451's answer today, silence, so a decision there changes this test on purpose.
- **n2. A printable `--pin-source` is printed as it is.** With `_spelled` in place of `_shown` in `plan`'s `pin` line, every test still passed. `test_a_printable_pin_source_is_printed_as_it_is` holds `plan`'s `pin` line, and `check`'s `write` line for the plan `plan` wrote, to their exact text, ending `(local-clone (<path>))` with no backtick.
- **n3** needs a code change and is left out (below).

**Fix round 2, on f63d1ed.** Each run had a `gh` stub first on PATH (it logs and exits 97), `GH_TOKEN` bogus, an empty `GH_CONFIG_DIR`, `git-filter-repo` 2.47.0 next on PATH, and the identity blanked with `GIT_CONFIG_COUNT`; the session `gh` guard came first inside each run.
- **The pin set: 812 passed, 2 skipped.** It covers adopt pins, adopt plan, #339's file, #275's tests, the pin and neutral-pin validators, git output decoding, adopt template values, CLI reference, scaffold pin and reuse, scaffold pin collisions, #314's two files and #396's file. The skips are `test_adopt_plan.py:403` (no MedxEHR clone) and `test_adopt_template_values.py:223` (this host reads `git config user.name` from the repository, not from `GIT_CONFIG_GLOBAL`). That is fix round 1's 809 passed, plus the three new rows.
- **Shape doctor and scaffold leg-path collisions: 369 passed, 3 skipped** (the PowerShell line exists only on a Windows host).
- **Mutation probes**, each one line changed in a throwaway worktree, over `tests/test_adopt_pins.py` and `tests/test_pin_source_unreadable.py` less the five end-to-end adoptions:
  - the `args.pin and` guard dropped: 2 failed, both n1 rows;
  - `plan`'s `pin` line `_spelled`: 1 failed, the n2 test;
  - `check`'s `write` line `_spelled`: 2 failed, the n2 test and `test_an_upper_cased_hand_edit_is_written_lower_cased`;
  - `plan`'s `pin` line raw: 1 failed, the no-break-space test that already guarded that hunk.

**On the merged tree, 73d65c6** (the merge f9ed46f and the `_read_pins` commit), with the same harness:
- **The pin set** above, with #445's `test_adopt_late_failure.py`, `test_adopt_git_reads.py` and `test_adopt_filter_repo_failure.py` and #387's `test_adopt_empty_symlinks.py` and `test_adopt_root_manifest.py`: **988 passed, 2 skipped**. The skips are the two above.
- **Shape doctor, scaffold leg-path collisions and the adopt suites:** **967 passed, 3 skipped** (the PowerShell line). The adopt suites are e2e, execute refusals, verify, root shape paths (#387's too), leg-path collisions, clone template, ignored shape files and submodules.
- **On the merge alone, f9ed46f** (the same tree as before the `_read_pins` commit): `tests/test_adopt_late_failure.py` gave 3 failed, 83 passed, the three `AttributeError` rows above.
- `render-cli-reference.py --check` is ok on the merged tree. pyflakes reports the same four warnings on `adopt-project.py`, `scaffold-project.py` and `scripts/shape_materialize.py` as before the merge.

**Fix round 1, on 421e4e5.** Each run had `git-filter-repo` 2.47.0 on PATH and the identity blanked with `GIT_CONFIG_COUNT`. A `gh` stub that logs and exits 97 was first on PATH, with `GH_TOKEN` bogus and an empty `GH_CONFIG_DIR`, and the session `gh` guard came first inside each run.
- **The pin set:** 809 passed, 2 skipped (the same files and skips as above).
- **Doctor and scaffold:** 782 passed, 3 skipped (the PowerShell line exists only on a Windows host). It covers shape doctor, scaffold leg-path collisions, scaffold e2e, referent chain links, naming policy, repo hygiene and #351's free-text values.
- **The adopt suites:** 882 passed. It covers e2e, execute refusals, verify, spec-only, leg paths, root shape paths, plan escapes, leg-path collisions, clone template and submodules.
- **Before the #314 merge,** on 74ce4d9's tree: the first two sets gave 577 passed, 2 skipped and 782 passed, 3 skipped. On 2bcfa69's tree (the merges alone, before the fix) they gave 542 passed, 2 skipped and 782 passed, 3 skipped. After the 45e01f4 merge, `tests/test_agents_md_codes.py`, repo hygiene and CLI reference: 110 passed.
- **Lane 5's second review** also ran 421e4e5 merged with main cb7063f and with 53bee5b: the pin set, the manifest-value set, and the doctor set with #357's `tests/test_doctor_validator_rows.py`. All passed, with only the skips above.

Proof that fix round 1's tests test something:
- **On 2bcfa69's tree,** with this head's two test files laid over it, 31 of the new rows fail:
  - S1: 17;
  - N2 and its report spelling: 7;
  - S2: 3;
  - the `pin_product_key` port: 2;
  - `check`'s S3 line: 1;
  - the not-UTF-8 `adopt plan` row: 1.

  The N3 rows pass there, as they must: they guard hunks this branch already had.
- **Mutation probes.** Each hunk was reverted alone, in a throwaway worktree, and both test files were run: 18 of 18 were caught.
  - **The port:** the casefold keying (2 fail); the casefold lookup alone (2).
  - **S1:** the path named raw (13); git's reason named raw (2); every path `repr`'d, printable or not (27).
  - **S2:** no `except` (3).
  - **N2:** no `plan` check (11); only #270's question asked (1); the formatting-character reason said otherwise (1); the report's `pin` line raw (1); `check`'s `write` line raw (1).
  - **S3:** the line dropped (1).
  - **N3:** the `_pin_fix` name guard (1); the `_read_pins` path guard (1); the lower-casing (1); the `digest_source` check (1); the not-text check (1); the gitlink filter (1).
- **The issue rows reproduced.** S1, S2 and N2 were reproduced on 2bcfa69's tree and shown gone on the fix (a probe driving both tools; `gh` was called 0 times).

**Before fix round 1.** Runs were on 7a94b6b, with `git-filter-repo` 2.47.0 first on PATH and the repository-local `user.name` blanked with `GIT_CONFIG_COUNT` (a workstation whose standard checkout sets one fails `test_the_scaffold_refuses_with_no_elector` on main itself; CI sets none). 7a94b6b differs from ffd1297 in `tests/test_pin_source_unreadable.py` only, so the three suites that do not read that file ran on ffd1297:

- the new file: 46 passed;
- adopt pins, adopt plan, git output decoding: 172 passed, 1 skipped (the MedxEHR clone is absent);
- scaffold pin and reuse, pin collisions, e2e, referent chain links, neutral pin and pin validators, #275's tests, naming policy, repo hygiene, CLI reference, scaffold leg-path collisions: 571 passed;
- shape doctor: 254 passed, 3 skipped (the PowerShell line exists only on a Windows host);
- the new file with repo hygiene, git output decoding and CLI reference, once more after the last edit: 176 passed.

Earlier on 5690235 and d806e8f, before the #339 commit: the adopt suites (e2e, execute refusals, verify, spec-only, leg paths, root shape paths, plan escapes, leg-path collisions, clone template) 740 passed, and `tests/test_adopt_template_values.py` with #273's other adopt tests 489 passed, 2 skipped. They were not re-run on 7a94b6b: the #339 diff touches `pin_digest_from_source` and the call in `declared_pin_values`, which those suites reach through `test_adopt_pins.py` only. Nothing was run on macOS or Windows.

Proof the new tests test something:
- **On d806e8f.** 38 of the 46 fail, each on the traceback and its exit 1. The 8 that pass are the unchanged behaviour: the not-a-clone refusal (4 rows) and the valid-source rows (4).
- **Mutation probes.** Ten hunks reverted one at a time, each failing at least one new test: the `OSError` catch (16 fail), the catch narrowed to `OSError` only (21), the missing-path clause (9), the clause narrowed to `FileNotFoundError` (3), the `S_ISDIR` judgement (3), the loop guard (4), no resolve at all (3), the old `.resolve()` call (4), the reason as `str(exc)` (12), and the file sentence as the OS's (3).
- #273's own 52 tests still fail on c7c02fa (51 fail or error; the one that passes checks the test's own table), and its 18 mutation probes were each caught.

**Re-verified after the merge.** An independent re-verification of f9ed46f and 73d65c6 found the code correct:
- #409 is carried whole. A 30,000-case fuzz of `--pin` lists through #409's final refusal and this branch's port differed in 0 cases.
- `scaffold-project.py` equals the tested file plus main's own changes that are not #409's (same patch-id).
- `_commit_the_split` keeps #445's `try` and #394's `append`.
- `_read_pins` reads a loaded plan as before.

Its findings were all in this description (the #506 bullet and three stale facts), now fixed. Runs on the head and on its merge with main 48585e6: 988 passed, 2 skipped; and 967 passed, 3 skipped.

`git merge-tree --write-tree` was run at 01:48Z on 2026-10-13, comparing hunks per file. Each PR head, fetched from `refs/pull/<n>/head` with no `gh`, was merged with 73d65c6 and with origin/main 9736424 alone. Two sets were asked about:
- every PR this description listed before that main does not now contain;
- every PR numbered above #468 whose head main does not contain: #473, #474, #490, #491, #493, #494, #495, #496, #497, #503, #504 and #505.

**Open state, read with `gh` by the coordinator at 02:00Z and refreshed at 02:25Z after a re-verification on main 48585e6.** Every pull request named below is open. #184, #94, #96, #98, #100 and #161 are closed, and #465 landed as 48585e6. `fix/adopt-plan-quote-yaml-keywords` has no pull request. #506 (`fix/scaffold-reuse-seeded-legs`) opened after this list was made, and the re-verification reads it.

- **Landed since the last draft of this list:** #343, #346, #355, #358, #373, #378, #382, #387, #394, #397, #401, #404, #409, #419, #452, #456, #465, #466 and #484. #394's `_commit_the_split` conflict and #401's `docs/cli.md` conflict are both resolved in f9ed46f, above.
- **Clean, 20:** #266, #347, #356, #374, #376, #384, #395, #453, #467, #468, #473, #474, #490, #491, #493, #494, #495, #497, #503 and #505. #453, #468 and #491 were updated onto main since the first read and now merge clean. #507 (lane 5's #486-#488) shares only the generated `docs/cli.md` with this branch and merges clean with it.
- **Conflicting with main alone, and this branch adds no hunk:**
  - #402: `shape-doctor.py` 5;
  - #496: `shape-doctor.py` 10 and `tests/test_shape_doctor.py` 1.

**Conflicts this branch adds:**
- **#435** (3efcc7a, lane 2's `fix/adopt-plan-field-types`, for #386).
  - It adds 2 hunks in `adopt-project.py`: 5 here, against 3 with main alone. They are `render_plan`'s `pins:` line and `Plan.pins`.
  - Keep this branch's `_pin_lines` and `_pin_products`. The rest is under "Where the meaning meets".
- **#504** (37ef29a, `fix/adopt-root-kept-symlinks`).
  - It adds 1 hunk in `adopt-project.py`: 2 here, against 1 with main alone. It is the materializer call in `_commit_the_split`.
  - Keep both arguments and both comments: `append=append, neutral_pins=_recorded_pins(plan), spell=_spelled`.
- **#506** (119d8c4, `fix/scaffold-reuse-seeded-legs`).
  - It adds 1 hunk in `scaffold-project.py`. With main alone, #506 conflicts only in `docs/handbook.html`.
  - #506 inserts `LEG_TEMPLATES` right after `declared_pin_products`, which this branch moved out, and rewrites `_reusable_remotes` further down. Keeping both sides breaks the file with an unterminated string literal.
  - Keep only #506's `LEG_TEMPLATES` block. Drop #506's `declared_pin_values`/`declared_pin_products`, which moved here, and this branch's three-line `_reusable_remotes` opener, which #506 rewrites below. Resolved that way, pyflakes is clean and #506's scaffold tests pass (88).
- **`fix/adopt-plan-quote-yaml-keywords`** (ed9968f; a branch with no pull request).
  - It adds 2 hunks in `adopt-project.py`: 3 here, against 1 with main alone.
  - One is `render_plan`'s `pins:` line. Keep `_pin_lines`, which already sends product, repository and `digest_source` through `y`.
  - The other is `_refuse_unholdable_values`' signature. Keep `pins: dict`, with that branch's `_validator_judged` and `_named_as_read` above it.
- `fix/adopt-late-failure-notice` is no longer on origin. #445, the late-failure notice, is on main and merged here.

**Where the meaning meets:**
- **#435 and #386.** The coordinator has said this on #435: #435 (comment)
  - #435's `_plan_key_findings` (`plan-bad-pins`) keeps only text items in `pins:`, and its `PINS_REMEDIATION` tells a person to write `pins: [openGlass]`.
  - This branch writes each pin as a mapping, and it makes a name alone `plan-pin-unrecorded`.
  - Read from #435's code, not run: on a tree with both, the plan `plan --pin` writes is `plan-bad-pins` in `check`.
  - Whichever lands second reconciles them, with three changes:
    - `_plan_key_findings` takes this branch's mappings, or leaves `pins:` items to `_read_pins`;
    - a `pins:` that is not a list gives one finding, not both `plan-bad-pins` and `plan-pin-malformed`;
    - `PINS_REMEDIATION` says the mapping `plan` writes.
  - Until that is done, `tests/test_adopt_pins.py::test_a_plan_with_a_whole_pin_checks_ok` fails.
- **#314.** It landed, and it is merged here (above).
- **`fix/adopt-plan-quote-yaml-keywords`.** Its pin tests are written against the name-only `--pin`. They need the `name@commit` form, and their expected `pins: [...]` line becomes `_pin_lines`'s mapping.

- **Two unwritable values are refused in two runs (lane 5's second review, n3).** `plan --elected-by 'A<LF>B' --pin openGlass@<sha> --pin-source <a path holding an ESC>` refuses the elector alone, exit 2. Re-run with the elector retyped, it refuses the source; #270's refusal names every unwritable value at once. Reproduced on 421e4e5, with `gh` called 0 times. One refusal would need a code change, not made here:
  - `_refuse_an_unrecordable_pin_source` would split into a function that returns the sentence;
  - `_checked_plan_inputs` would ask it before #270's `unwritable_values` raise, and raise one `adopt-unwritable-value` that names both, with both remediations;
  - a test would add the two-value row.

  N2's question is `one_printable_line`, not `unwritable_reason`, so it cannot simply join #270's list.
- **Docs.** The README, AGENTS.md and `docs/handbook.html` are unchanged, because none of them calls adopt's `--pin` a name. A sentence saying adopt now takes the scaffold's `--pin` is a follow-up. It costs an AGENTS.md line-cap raise, and a README edit forces the handbook's README blob to change.
- **A product spelled `null`, `true` or `false`.** The scaffold already accepts `--pin null@<sha>`: it exits 0 and builds a root whose `validate-pins.py` exits 1 `neutral-pin-entry-malformed`. Adopt's `plan` writes `product: null` through `y`, and `check` then finds `plan-pin-malformed` and refuses it before any leg exists. The one fix for both tools is in `parse_pin`, and it would change the scaffold's behaviour.
- **Wording shared with the scaffold.** `digest_source` is written bare into the pin file, so a `--pin-source` path holding ` #` is cut short there. `templates/assembly-root/contracts/neutral-product-pin.yaml` and `validate-pins.py`'s `neutral-pin-missing` remediation name only the scaffold as the writer. Two comments in `scripts/repo_shape.py` still name the scaffold's `pin_digest_from_gh`, in a digest-pinned shipped copy.
- **Filed as follow-ups:**
  - #449: S3, a hand-edited `commit:` or `tree_sha256:` that disagrees, with options (a) and (b);
  - #450: the scaffold half of N2, a `--pin-source` path no file can hold;
  - #451: #339's third decision (N5), a `--pin-source` that nothing reads.
- **`validate-pins.py` prints a `--pin-source` path raw** in `neutral-pin-source-unreadable`, the twin of S1. It is a shipped template that #409 and other open PRs edit, so it is left for its own change. No issue is filed for it yet.
- **Windows and macOS** were not run here; CI ran both (below). Two assertions that depend on what Windows answers for a path (a name past the filesystem's limit, a path beneath a file) check only the refusal and its remediation there. Fix round 1's rows that need a control character or a byte that is not UTF-8 in a path, or a symlink to `git`, are skipped on Windows by a mark, and so is fix round 2's ESC row. The rows for a no-break space and a zero-width joiner run everywhere, and so does the in-process `gh-not-found` test.

Reviewed independently by lane 5 at 7a94b6b (3 should-fix, 5 nits: fix round 1) and at 421e4e5 (0 blockers, 2 should-fix, 3 nits: fix round 2). After #409's squash, the re-verification of f9ed46f and 73d65c6 found the code correct; its 1 should-fix and 3 nits were in this description and are fixed. GitHub's update-branch then merged main twice (33bae3f, 2170526), with no hand edit. CI's tests, tests-macos and tests-windows and SonarCloud all passed at 2170526 (main cac6bb2 merged in). On that head merged with main 57c85e9 (#490, #474 and #468, none of which touches this branch's files), the pin and adopt set with `tests/test_update_shape_landing.py` gave 1112 passed, 2 skipped, and the doctor, adopt end-to-end, unfinished-merge and bootstrap set gave 1056 passed, 3 skipped (the doctor's PowerShell line, which exists only on a Windows host).

Closes #273
Closes #339

Lane: openreposhape-5 (openRepoShape-5)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant