Skip to content

docs(comments): restore four facts the lint-floor sweep cut - #560

Merged
Vivswan merged 1 commit into
mainfrom
docs/restore-thinned-comment-facts
Oct 26, 2026
Merged

Vivswan merged 1 commit into
mainfrom
docs/restore-thinned-comment-facts

Conversation

@Vivswan

@Vivswan Vivswan commented Oct 26, 2026

Copy link
Copy Markdown
Owner

What this specifies

.github/scripts/post-green-steps.ts          DRY_RUN_PUSH         how the dry run judges the token: origin's receive-pack
                                                                  advertisement, over the real push's channel
src/sections/contract/endpoints.ts           ReadPhase            an execution-phase read, for one: the Codespaces sealing key
src/sections/environments/schema.ts          the flags rule       GitHub answers 422 to both flags true and to both false;
                                                                  "any branch may deploy" is deployment_branch_policy: null
src/sections/shared/secrets-and-variables/   SegmentOfSecretsKey  a fifth family breaking `<segment>_secrets` must say so here
  repo-secrets.ts

How

  • Comment-only: no code moves; each fact sits beside the thing it explains, one line where the member-shape rule wants one.
  • Found by an audit of the 1944 comment lines the floor sweep removed: 427 carried a risk word, 21 survived nowhere verbatim, and these 4 had lost the fact rather than the wording.

Proof

  • Fleet gates, locally with the platform's actions: member-shape 0, line cap 0 errors, biome 0 under the floor.
  • Gate: typecheck and biome ci clean.

An audit of the comment lines the sweep removed found four whose fact went with the wording: how the dry-run push judges the token (origin's receive-pack advertisement over the real push's channel), an example of an execution-phase read (the Codespaces sealing key), GitHub's 422 on both deployment-branch flags true and on both false, and the instruction that a fifth secret family breaking the <segment>_secrets naming must say so at the type that spells it. Each returns beside the thing it explains, one line where the member-shape rule wants one.
Copilot AI balanced review requested due to automatic review settings October 26, 2026 19:58
@github-actions

Copy link
Copy Markdown
Contributor

File size check

0 over a hard cap (fails), 6 warning(s).

File Size Tier Cap
src/engine/diff.ts:56 11 comment lines warn 10
src/github/api-error.ts:9 11 comment lines warn 10
src/problem.ts:73 18 comment lines warn 10
src/sections/contract/errors.ts:13 11 comment lines warn 10
src/sections/contract/module.ts:55 12 comment lines warn 10
src/sections/shared/list/decl.ts:265 14 comment lines warn 10

Split the file, wrap the line, shorten or exempt the comment, or list the path in .file-size-allow.local with a # reason.

5 managed file(s) skipped; repo-platform owns them.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The changes only clarify existing behavior, and no unresolved defects were identified.

No open issues 🎉

What changed in this PR

Restores four explanatory facts removed during the lint-floor sweep, documenting existing behavior in the settings action and its workflow helpers. All changes are comment-only.

Changes:

  • Clarifies how the dry-run push checks token access.
  • Documents execution-only reads and valid deployment branch policy flags.
  • Explains the naming constraint for repository secret families.
File Description
src/​sections/​shared/​secrets-and-variables/​repo-secrets.ts Documents the secret-family naming constraint.
src/​sections/​environments/​schema.ts Explains rejected flag combinations and the unrestricted deployment setting.
src/​sections/​contract/​endpoints.ts Adds the Codespaces sealing key as an execution-only read example.
.github/​scripts/​post-green-steps.ts Explains the dry-run push channel and probe ref.

Review effort: Balanced

@Vivswan
Vivswan marked this pull request as ready for review October 26, 2026 20:03
@Vivswan
Vivswan merged commit a00a3eb into main Oct 26, 2026
31 checks passed
@Vivswan
Vivswan deleted the docs/restore-thinned-comment-facts branch October 26, 2026 20:09
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.

2 participants