Skip to content

check-links: one suggestion per fix, synced with findings; one fact per line in reports - #1916

Open
marcleblanc2 wants to merge 6 commits into
mainfrom
check-links-report-format
Open

check-links: one suggestion per fix, synced with findings; one fact per line in reports#1916
marcleblanc2 wants to merge 6 commits into
mainfrom
check-links-report-format

Conversation

@marcleblanc2

Copy link
Copy Markdown
Contributor

Follow-ups from testing the PR checks on #1913 / #1914.

  • Review comments: one suggested change per finding (not one per line), no review body. Each comment starts with an HTML marker; the workflow deletes suggestions whose finding is gone (or that GitHub could no longer place, line: null) and skips ones already posted, so resolved suggestions disappear like the spell check's do.
  • Summary comment and review comments put line, link, problem, and fix each on their own line.
  • Absolute links to this site get their own Absolute links section instead of being lumped into Outbound.
  • Case-mismatch findings now come with a fix (/Code-Search/queries/code-search/queries).
  • Wording: "Write links on this site as relative paths", "fix the inbound links on these other pages", dropped https://docs.sourcegraph.com/…; reproduce command matches package.json (pnpm check links …).

Tested locally against the test-pr-checks-broken branch with the CI recipe (baseline from origin/main, --diff, --review); build-mode run (node dev/check-links.mjs) still clean.

Trade-off: when several fixes sit on one line, applying one suggestion outdates the others until the next run re-posts them, because GitHub will not batch overlapping suggestions.

… fact per line

- Review comments: one suggested change per finding with a fix, no review
  body. Each starts with a marker so the workflow can delete suggestions
  for findings that are fixed and skip ones already posted.
- Summary comment and review comments list line, link, problem, and fix
  on their own lines.
- Absolute links to this site get their own section instead of Outbound.
- Case-mismatch findings now carry a fix.
- Wording: 'links on this site', 'these other pages', drop
  docs.sourcegraph.com; reproduce command matches package.json.

Amp-Thread-ID: https://ampcode.com/threads/T-01a08fee-74b4-76dc-aaf9-d1245d68fdc9
Co-authored-by: Amp <amp@ampcode.com>
@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sourcegraph-docs Ready Ready Preview Sep 11, 2026 3:14pm UTC

Request Review

@github-actions

This comment has been minimized.

… update comments whose text changed

Amp-Thread-ID: https://ampcode.com/threads/T-01a08fee-74b4-76dc-aaf9-d1245d68fdc9
Co-authored-by: Amp <amp@ampcode.com>
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