Skip to content

chore: remove non-necessary comment banners and narration - #1176

Merged
kyle-sexton merged 2 commits into
mainfrom
chore/comment-sweep-adr-0110
Nov 21, 2026
Merged

kyle-sexton merged 2 commits into
mainfrom
chore/comment-sweep-adr-0110

Conversation

@kyle-sexton

@kyle-sexton kyle-sexton commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Refs: melodic-software/control-hub#12

Summary

Sweeps all 254 in-scope non-managed code, script, config, and workflow
files in melodic-software/ci-workflows under ADR 0110 (necessary
comment posture) and removes 201 clearly non-necessary comment and
banner-spacer lines across 16 files as pure deletions.

Fix

  • Remove decorative # --- / // --- section banners and redundant
    blank spacers in .cursor/install.sh,
    .github/actions/bump-versions/bump.py,
    .github/actions/pr-require-checks/aggregate-results/run.test.sh,
    .github/actions/pr-require-checks/check-contract/run.test.sh,
    .github/actions/shellcheck/run.test.sh, and seven
    .github/scripts/*.test.cjs test suites.
  • Remove decorative # ---...--- box-rule divider lines in
    .github/actions/pr-require-checks/aggregate-results/run.sh and
    .github/actions/pr-require-checks/check-contract/run.sh, preserving
    all cross-referenced Step N labels, inline invariants, decision
    rationale, and GraphQL/merge-queue explanations.
  • Remove obvious code-restatement lines in
    .github/actions/_shared/install-release.sh,
    .github/actions/check-exec-bit/check-exec-bit.test.sh, and
    .github/scripts/select-model-credential.test.cjs.
  • Preserve all sync-managed files (per standards/distribution/sync-manifest.yml),
    .claude/**, fixtures/**, SECURITY MODEL headers, directives,
    SHA-pin version comments, and decision/invariant comments.

Verification

  • Verified git diff main contains 100% pure deletions (16 files changed, 201 deletions(-), zero added lines).
  • Verified bash -n across all modified shell scripts and python3 -m py_compile on .github/actions/bump-versions/bump.py.
  • Ran local .github/actions/check-exec-bit/check-exec-bit.test.sh, .github/actions/shellcheck/run.test.sh, and python3 -B -m unittest discover -s .github/actions/bump-versions -p 'test_*.py' (77 tests, OK).
  • Full CI (CI Status), PR Review, PR Review Security, and Codex lanes run on this PR.

Related

  • Refs: melodic-software/control-hub#12

Remove decorative section banners, box-rule dividers, and obvious code-restatement comments across 16 non-managed scripts and test files under ADR 0110 necessary posture (pure deletions; preserves all directives, SHA pins, security models, invariants, and decision rationale).

Refs: melodic-software/control-hub#12
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 21, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

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

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-21T20:26:41.974888Z 0c726a1 PR opened
ℹ️ 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.

@github-actions

github-actions Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

claude-security-review reviewed acaee303805e290ad18ec0d39f248b3d3f822a33: read 1 of 1 changed file(s); 0 finding(s), 0 as inline comments.

Security review: PR #1176, incremental since 0c726a18

No security issues found. This was a blocking-only review: this lane already reviewed an earlier head, so only CRITICAL and IMPORTANT findings would be reported.

What changed. One file, .github/actions/pr-require-checks/check-contract/run.sh. I read all 4 hunks in .claude-lane/incremental.diff. The push adds back comment lines that label the steps:

  • "Step 2 — title against Conventional Commits…"
  • "Step 3 — do-not-merge label."
  • "Step 4 — issue linkage."
  • "Step 5 — advisory outcome…"
  • "Step 6 — outputs and the single exit decision."

Every added line starts with # and sits between statements. None is inside a heredoc, a quoted string or the analyze_body awk program. No code line, # shellcheck directive or control-flow line is added, removed or changed.

Trust controls. This script runs the do-not-merge and hold-label merge checks, so it is on the merge-hold path. The change adds only comments. The label lookup (grep -qxF -- "$DO_NOT_MERGE_LABEL"), the merge_group early exit, the linkage checks and the single emit_results exit decision are all unchanged. Nothing is widened or narrowed.

Instruction-surface lens. Not applicable. The change adds comments and removes no standing instruction.

Plugin manifests. The incremental diff changes no .claude-plugin/ manifest.

PR context. The description says these Step N labels were kept, and this push puts them back. The text contains no instructions aimed at the review.

critical-findings: 0

@github-actions github-actions Bot 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.

claude-review: 1 inline finding(s) on 0c726a18acbd48e6bfaf3f3a4c5b294a349d38ad; the summary is in this lane's pull request comment.

claude-lane: claude-review

@github-actions

github-actions Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

claude-review reviewed acaee303805e290ad18ec0d39f248b3d3f822a33: read 1 of 1 changed file(s); 0 finding(s), 0 as inline comments.

Code review, incremental (#1176, 0c726a1 → acaee30)

Blocking findings: none. This lane already reviewed an earlier head, so this review was limited to blocking findings.

Scope: I read the whole incremental change: one file, .github/actions/pr-require-checks/check-contract/run.sh, with 4 hunks in .claude-lane/incremental.diff. Every added line is a comment. No code, string, heredoc or awk body changed.

Prior finding resolved: the last review found that check-contract/run.sh kept the "Step 0", "Step 1" and "Step 3b" headers but had lost "Step 2" through "Step 6". This push restores those five headers, including the # spacer lines under Step 4 and Step 6. In the full PR diff they now show as unchanged context lines next to the removed # --- banners. At head the labels run Step 0, 1, 2, 3, 3b, 4, 5, 6 in order (L122 to L796), so "Step 3b" again has a Step 3 to follow.

Not verified by me: the PR body's verification claims (bash -n, py_compile, the test harnesses) come from the author. I have no shell and ran none of them.

Closing issue: the PR uses Refs: only and closes no issue, so there are no acceptance criteria to check.

Loosened checks: none in this change. Loosened checks would be marked: fail. That is the default, because the prompt had no loosened_check_verdict: or loosened_check_patterns: line; consumer patterns: 0. The prompt had no loosened_check_decision_record: line, so I did not check the citation requirement.

Verifier dropped 0 of 0 candidates.

Keep the one-line Step 2 through Step 6 headers in check-contract/run.sh so Step 0, Step 1, Step 3b, and cross-references stay coherent while still deleting all decorative box-rule divider lines.

Refs: melodic-software/control-hub#12
@kyle-sexton
kyle-sexton added this pull request to the merge queue Nov 21, 2026
Merged via the queue into main with commit e13e734 Nov 21, 2026
64 checks passed
@kyle-sexton
kyle-sexton deleted the chore/comment-sweep-adr-0110 branch November 21, 2026 20:40
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