Skip to content

release: 0.7.0 — the diagnostics get a home and the changelog catches up - #16

Merged
DivyamTalwar merged 1 commit into
mainfrom
docs/interrogate-and-polish
Sep 5, 2026
Merged

DivyamTalwar merged 1 commit into
mainfrom
docs/interrogate-and-polish

Conversation

@DivyamTalwar

@DivyamTalwar DivyamTalwar commented Sep 5, 2026 •

Copy link
Copy Markdown
Owner

The final pull request before tagging v0.7.0. Two commits: a README section, and the release record.


1 · The three diagnostics get a home

#7, #8 and #9 each added a read-only diagnostic, and each appended a sentence wherever its own change happened to touch the README. Two ended up as orphan paragraphs below the development gate; the third existed only as a comment inside a code block.

Read separately they look like three unrelated utilities. They aren't — they're the same capability at three moments:

Moment Question Command
Before you pick a client Which host can actually honour the contract I need? bun run plan
After you install What is really on disk, and does it still match? bun run doctor
When the tool surface moves What changed, and is any of it permission-bearing? bun run tools:review

New "Interrogate it yourself" section, placed between What it will not do and When not to use this, so the honesty block reads in one run: what it refuses to do → how you check that yourself → when you shouldn't use it at all. Organised by moment rather than by tool, each entry leading with what the command refuses to do. It closes by inverting the usual precedence: if a diagnostic disagrees with the README, the README is wrong.

Every documented invocation was run, not copied from a PR description:

$ bun run plan -- --require-effort --minimum-readonly tool-allowlist --scope project
  "bestFit": "codex",  "compatible": ["codex"],  "refused": ["cursor", ...]

$ bun run tools:review
  "changed": false,  "permissionExpansion": false,  "requiresReapproval": false

$ bun run doctor -- --workspace <abs>
  "schema": 2,  "readOnlyMechanism": "os-sandbox",  per-role adapter state

2 · The changelog catches up, and 0.7.0 is cut

Four pull requests merged into main without a changelog entry between them — #9, #8, #7 and #15. The Unreleased section described only the Astra lane, so the three most user-visible additions since 0.6.0 existed in the code and in the README but nowhere in the release record. A changelog that silently omits four merges is worse than none, because it is read as complete.

All four are now documented, Unreleased is cut as 0.7.0, and the three declared versions agree.

Minor rather than patch: this release adds a second native implementation lane and three read-only diagnostics. Nothing is removed and no interface breaks, so it is not a major — though 1.0.0 is a maintainer's call rather than a semver one, and this is arguably the release that earns it.


Verification

bun run ci
bun run tag:check -- v0.7.0

VERIFY PASSED three-role · 82 tests across 6 files, 0 fail · validate · sbom now emitting orrery-0.7.0.cdx.json (18 packaged files, 0 runtime dependencies) · release-check · tag-check passes for v0.7.0, so the tag and all three manifests agree.

Not in this PR

The three README images. They were generated, but they are branded FABLEWRIGHT rather than ORRERY, and the refusal image shows two role filenames and an install command that do not exist in this repository. Embedding them would put a claim on the front page that the shipped files contradict — the exact failure verify.sh guards against. They land in a follow-up once corrected.

Risk

Documentation and version metadata only. No code, no behaviour change.

Problem
Orrery gained three read-only diagnostics in three separate pull requests — the
capability planner (#7), the tool-surface review (#8), and the semantic
compatibility doctor (#9). Each arrived with a sentence appended wherever its own
change happened to touch the README, so two of them ended up as orphan paragraphs
below the development gate and the third existed only as a comment inside a code
block.

Read individually they look like three unrelated utilities. They are not: they are
the same capability at three different moments — before you choose a client, after
you install, and whenever the tool surface moves. That framing was nowhere on the
page, so the most checkable thing about this project was also the least visible.

Approach
Add "Interrogate it yourself" between "What it will not do" and "When not to use
this", so the honesty block reads in one run: what it refuses to do, how you can
check that for yourself, and when you should not use it at all.

The section is organised by moment rather than by tool, and each entry leads with
what the command *refuses* to do, because that is the part with value. A path-only
portability matrix would report six clients as working; the planner names the ones
that would quietly downgrade advisor isolation and refuses them. The doctor
separates what it observed on disk from what it cannot know about runtime
behaviour. The review turns "the digest moved" into whether the thing that moved
can take a new argument, hold state, or has dropped a `readOnlyHint`.

It closes by inverting the usual precedence: if a diagnostic disagrees with the
README, the README is wrong.

Verification
Every documented invocation was run, not copied from a pull request description.
`plan` with the documented flags returns `bestFit: codex` and refuses cursor and
the remaining clients. `tools:review` returns `changed: false`,
`permissionExpansion: false`. `doctor` reports schema 2 with `readOnlyMechanism`
and per-role adapter state. `bun run ci` is green.

Impact
Documentation only.
@DivyamTalwar
DivyamTalwar merged commit f791ddd into main Sep 5, 2026
4 checks passed
@DivyamTalwar
DivyamTalwar deleted the docs/interrogate-and-polish branch September 5, 2026 08:32
@DivyamTalwar DivyamTalwar changed the title docs: give the three read-only diagnostics a home release: 0.7.0 — the diagnostics get a home and the changelog catches up Sep 5, 2026
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