Skip to content

docs(changelog): keep the notes added since v0.14.0 within the character cap - #1193

Merged
ragnorc merged 2 commits into
ModernRelay:mainfrom
ragnorc:docs/changelog-ensure-indices-length
Oct 28, 2026
Merged

ragnorc merged 2 commits into
ModernRelay:mainfrom
ragnorc:docs/changelog-ensure-indices-length

Conversation

@ragnorc

@ragnorc ragnorc commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Trivial fast-lane. Four notes added since v0.14.0 exceed the caps scripts/release_notes.py enforces (200 visible characters; 400 for breaking): three from #1150 (283, 277, 496) and the Nix flake note from #1153 (255). The Check AGENTS.md Links job therefore fails on main and on every open PR. Each note is shortened without dropping a fact; python3 scripts/check-docs.py passes with this change.

@ragnorc ragnorc changed the title docs(changelog): keep the ensure-indices note within 200 characters docs(changelog): keep the notes added since v0.14.0 within the character cap Oct 28, 2026

ragnorc commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

Recommendation: ready.

Why

An unreleased changelog note has a visible-text cap. scripts/release_notes.py allows 200 characters, and 400 for a breaking note. scripts/check-docs.py runs that check, and the Check AGENTS.md Links job runs check-docs.py. On main (f76d6011) four notes are over the cap, so the job fails.

What

This pull request shortens those four notes. The reviewed head is 27b56c2c431289d669d3f59be4de8c39649b8bc7. The branch moved during review: a9b67c7 shortened only the ensure-indices note, and 27b56c2 shortens the other three and names the Change action on the ensure-indices note.

How

Each file stays one bullet. The index-build note and the Nix note still link the guide that holds the long form. The other two notes keep the operator-visible outcome: which entry points rebuild lagging BTREE and vector coverage, which full-text state stays pending, which commands the refusals name, and that a policy requires an actor with Change.

Impact

The documentation check passes at this head. The release text is shorter. Index build, ensure-indices, and the Nix flake keep their current behavior.

Blocking findings

None.

Optional findings

  1. The pull-request text says each note keeps every fact. A few phrases left the notes. The sentences that remain are accurate, and the longer form still lives in the linked guide or in a sibling note.
    • ensure-indices-refreshes-coverage.changed.md no longer says that the pending full-text reason includes the rebuild command. append_deferred_full_text_indexes still puts FULL_TEXT_REBUILD_COMMAND in that reason. The Build indexes section tells the operator to run index rebuild --kind full-text.
    • index-build-command.added.md no longer says "declared", "one graph commit", or the first-rows example. That same Build indexes section still says them. The embedded call ensure_indices_on_as remains in the changed note.
    • nix-flake.added.md no longer says "from source" or "packages and features". The Nix section still says the flake builds from source with the release archives' packages and features. flake.nix passes --features omnigraph-server/aws.
  2. "Fails on every open PR" fits a new run that merges current main. Stored status on older pull requests can still be green. PR docs(release): foreground v0.10 vocabulary break #590 still shows a green Check AGENTS.md Links job from 2026-09-01. PR docs(readme): shorten the Cloud line #1192, which ran after these notes landed, fails that job.
  3. check_release_inputs raises on the first over-cap note. That is why main reports only the 283-character note, and why a9b67c7 then failed on the 277-character note. This head covers all four notes a full scan finds. A later edit could collect every cap error in that one function, so the next set is visible together.
  4. Open PR feat(policy)!: gate maintenance behind the maintain and reclaim actions #1175 plans to gate maintenance with maintain and reclaim. This note matches current ensure_indices_on_as, which calls enforce with PolicyAction::Change. If feat(policy)!: gate maintenance behind the maintain and reclaim actions #1175 merges, that pull request has to edit this sentence.

Tradeoff and liability

The cap already has one owner, check_note_caps. This change uses that owner. It adds no API, no stored state, and no new invariant. It removes a red documentation job on main and on a fresh pull-request run. It adds four shorter sentences. Operator detail stays in the user guide. Five more edits of this kind stay a wording change each. The smaller diff is useful because the four over-cap notes from #1150 and #1153 are closed together, which is the whole current class.

Validation

Merge base and current main: f76d6011f0479055e1e2c7dffe253ac3ee556d3b.
Reviewed head: 27b56c2c431289d669d3f59be4de8c39649b8bc7.

This pull request changes changelog text only. A changelog cap is outside GQT. The docs check is the regression proof.

Local, with markdown-it-py==4.0.0 and mdurl==0.1.2:

  • python3 scripts/check-docs.py at f76d6011: exit 1. changelog.d/ensure-indices-refreshes-coverage.changed.md: 283 characters, over the 200-character limit for .changed.md notes.
  • The same command at 27b56c2: exit 0. Documentation OK (421 Markdown files checked).
  • A length scan through release_notes.visible_text on the unreleased note set: at f76d6011, four notes over the cap (index-build-command.added.md 496, ensure-indices-refreshes-coverage.changed.md 283, full-text-remedies-parse.fixed.md 277, nix-flake.added.md 255). At 27b56c2, zero notes over the cap (190, 197, 196, and 198 in that same file order).

GitHub:

  • main f76d6011, run 40759976321, job Check AGENTS.md Links 123068951102: fail, the same 283-character error.
  • Commit a9b67c7, run 40761552122, job 123074520527: fail, changelog.d/full-text-remedies-parse.fixed.md: 277 characters.
  • Head 27b56c2, run 40762412933, job 123078089326: pass.

Wording checked against the merge base, which this pull request leaves unchanged:

  • ensure_indices_on_as rebuilds lagging BTREE and vector coverage, reports full-text coverage as pending, and calls enforce with Change.
  • TableStore::can_fold_index skips full-text indexes. has_foldable_unindexed_fragments is the lag signal ensure-indices uses.
  • index build calls ensure_indices_on_as. index_remedies_name_commands_that_parse_issue_840 parses INDEX_BUILD_COMMAND and FULL_TEXT_REBUILD_COMMAND.
  • The flake builds omnigraph, omnigraph-server, and omnigraph-azure-admission for x86_64-linux, aarch64-linux, and aarch64-darwin.
  • Note origins: be90423a (feat(cli): build a branch's declared indexes with omnigraph index build #1150) for the three index notes, 37b05ab4 (build(nix): build the release binaries with a Nix flake #1153) for the Nix note.

Limitations

The docs job on this head passed. Other jobs in run 40762412933 were still in progress when I read the run. Lance index-format pages stay out of this review. The pull request leaves Lance use unchanged, and the coverage words match foldable_index_lag and the user guide.

@ragnorc
ragnorc added this pull request to the merge queue Oct 28, 2026
Merged via the queue into ModernRelay:main with commit 2ca84a7 Oct 28, 2026
31 of 33 checks passed
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