Skip to content

Surface marker scan health and dangling claims in CI comments - #178

Merged
mbeacom merged 4 commits into
mainfrom
mbeacom-marker-comment-reporting
Aug 27, 2026
Merged

Surface marker scan health and dangling claims in CI comments#178
mbeacom merged 4 commits into
mainfrom
mbeacom-marker-comment-reporting

Conversation

@mbeacom

@mbeacom mbeacom commented Aug 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • report marker scan-health failures separately from an empty marker result
  • report healthy scans with dangling or log-qualified marker claims in bounded, safely rendered comment sections
  • preserve advisory-only marker semantics and changed-record validation priority under the GitHub comment budget
  • add focused regression coverage and document the checkout-root caveat

Closes #126
Closes #112

Copilot AI balanced review requested due to automatic review settings August 26, 2026 21:42
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Mark Beacom <m@beacom.dev>
@mbeacom
mbeacom force-pushed the mbeacom-marker-comment-reporting branch from f63902f to 1a827e0 Compare August 26, 2026 21:45

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.

🟡 Changes recommended

Marker sections need Markdown boundaries, and the budget-priority regression test currently filters out all marker claims.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Surfaces marker scan failures and unresolved claims in CI comments while preserving advisory semantics and validation priority.

Changes:

  • Adds bounded marker health and unresolved-claim sections.
  • Adds regression tests for rendering and non-blocking behavior.
  • Documents marker reporting and checkout-root requirements.
File summaries
File Description
packages/ci/src/comment.ts Renders marker health and claim findings.
packages/ci/test/comment-render.test.ts Tests bounded marker comment rendering.
packages/ci/test/action.test.ts Verifies dangling markers remain non-failing.
README.md Summarizes marker reporting behavior.
site/src/content/docs/ci.mdx Documents marker sections and checkout caveat.
Review details
  • Files reviewed: 5/7 changed files
  • Comments generated: 3
  • Review effort level: Balanced

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +125 to +128
lines.push(
'',
'These files could not be inspected for `@adr` markers; an empty result does not prove that no marker is present.',
);
Comment on lines +152 to +156
const remaining = claims.length - shown.length;
if (remaining > 0) {
lines.push(`- …and ${remaining} more marker claim${remaining === 1 ? '' : 's'}`);
}
return lines;
Comment on lines +157 to +161
outcome.findings.push(...Array.from({ length: 4000 }, (_, index) => ({
rule: 'dangling-marker',
severity: 'warn' as const,
message: `claim ${index} ${'x'.repeat(60)}`,
path: 'src/a.ts',
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Mark Beacom <m@beacom.dev>
@github-actions

github-actions Bot commented Aug 26, 2026

Copy link
Copy Markdown

Decisions governing this change

  • 0011 — Host the canonical JSON Schema at its $id on adrkit.dev
    • via path: site/**
  • 0016 — Require every check to be observed failing before it counts as coverage
    • via path: packages/*/test/**
  • 0022 — Scan inbound markers in check and CI without giving them exit-code authority
    • via path: packages/ci/src/**
  • 0026 — Identify the CI comment by the strongest author evidence the token allows
    • via path: packages/ci/src/comment.ts
    • via path: site/src/content/docs/ci.mdx
  • 0030 — Keep extension surfaces that carry a dependency tree outside this repository
    • via path: packages/ci/**
  • 0032 — Publish one lockstep OCI image after the coordinated release succeeds
    • via path: README.md
  • 0033 — Select interactive graph presentation at the CLI boundary while preserving piped DOT
    • via path: site/src/content/docs/**
  • 0035 — Execute the gates that certify a pull request from the default branch
    • via path: packages/ci/**

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Mark Beacom <m@beacom.dev>
@mbeacom mbeacom added the gate-change-acknowledged A maintainer has seen and accepted this PR's change to the CI gate surface (ADR-0035) label Aug 27, 2026
@mbeacom
mbeacom merged commit e9169e7 into main Aug 27, 2026
16 of 17 checks passed
@mbeacom
mbeacom deleted the mbeacom-marker-comment-reporting branch August 27, 2026 01:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gate-change-acknowledged A maintainer has seen and accepted this PR's change to the CI gate surface (ADR-0035)

Projects

None yet

2 participants