Skip to content

chore: mark the README terminal render as captured output - #315

Merged
askalf merged 1 commit into
masterfrom
chore/readme-terminal-protected
Oct 29, 2026
Merged

askalf merged 1 commit into
masterfrom
chore/readme-terminal-protected

Conversation

@askalf

@askalf askalf commented Oct 29, 2026

Copy link
Copy Markdown
Owner

Marks .github/readme/terminal.svg as redline-protected in .gitattributes.

The file is captured CLI output: scripts/readme/terminal.mjs renders it from a real run of this checkout's CLI, so its text is whatever the CLI prints. The verify summary line, for one, prints an em dash, which the public-text check would otherwise fail on.

Both checks read the mark from the base commit, never the head, so this has to merge before the README PR that adds the SVG and its generator. That PR is opened from docs/readme-world-class; its public-text check gets re-run once this lands.

Only .gitattributes changes. git check-attr redline-protected reports set for the SVG and unspecified for everything else.

.github/readme/terminal.svg is generated by scripts/readme/terminal.mjs
from a real run of the CLI, so its text is the CLI's own output (the
verify summary prints an em dash, for one). Marking it redline-protected
lets the public-text and redline checks skip wording findings on it.

The checks read the mark from the base commit, so it has to land before
the README change that adds the file.

@sprayberry-redline sprayberry-redline left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict: approve. The attribute correctly scopes the captured-output mark to the terminal SVG. One comment should be shortened to describe the file rather than the review-check implementation.

Minor:

  • .gitattributes:9: This comment narrates review-check behavior instead of documenting the attribute's purpose, so it adds patch-process detail that will become stale and is not useful to users of the file.

@askalf
askalf merged commit 201b4b4 into master Oct 29, 2026
19 checks passed
@askalf
askalf deleted the chore/readme-terminal-protected branch October 29, 2026 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Under 10 hand-written lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants