Skip to content

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

Merged
marcleblanc2 merged 6 commits into
mainfrom
check-links-report-format
Sep 11, 2026
Merged

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

Conversation

@marcleblanc2

@marcleblanc2 marcleblanc2 commented Sep 11, 2026

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.

Merge order for the PR-check stack

Trial-merged onto main in this order with no conflicts:

  1. ci: Comment the Vercel build log on PRs whose build fails #1946 Vercel build log comment — independent; first so the other PRs' Vercel failures get a readable log
  2. check-links: one suggestion per fix, synced with findings; one fact per line in reports #1916 check-links report format — adds dev/sync-review-comments.sh, which ci/redirects: Add Redirect check for PRs #1935 calls
  3. ci/redirects: Add Redirect check for PRs #1935 redirect check — needs check-links: one suggestion per fix, synced with findings; one fact per line in reports #1916 merged first
  4. spell check: update inline comments whose text changed #1947 spell check comment updates — independent
  5. check-links: don't fail the generated-docs sync PR over absolute self-links it can't fix #1944 check-links, generated-docs sync PR — conflicts with check-links: one suggestion per fix, synced with findings; one fact per line in reports #1916 on dev/check-links.mjs; rebase after check-links: one suggestion per fix, synced with findings; one fact per line in reports #1916 merges

Squash-merge each, then rebase the next onto main.

#1948 (broken) and #1949 (fixed) are the example PRs that exercise every check; never merge, close them once the stack has landed.

@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 10:19pm UTC

Request Review

@github-actions

This comment has been minimized.

@marcleblanc2
marcleblanc2 force-pushed the check-links-report-format branch from 4b59325 to 13ecf30 Compare September 11, 2026 15:12
auto-merge was automatically disabled September 11, 2026 18:03

Pull request was closed

@marcleblanc2
marcleblanc2 deleted the check-links-report-format branch September 11, 2026 18:03
@marcleblanc2
marcleblanc2 restored the check-links-report-format branch September 11, 2026 18:07
@marcleblanc2 marcleblanc2 reopened this Sep 11, 2026
@marcleblanc2
marcleblanc2 enabled auto-merge (squash) September 11, 2026 22:16
marcleblanc2 and others added 6 commits September 11, 2026 16:16
… 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>
… 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>
@marcleblanc2
marcleblanc2 force-pushed the check-links-report-format branch from 13ecf30 to d21cd71 Compare September 11, 2026 22:16
@marcleblanc2
marcleblanc2 merged commit f2a5d02 into main Sep 11, 2026
4 checks passed
@marcleblanc2
marcleblanc2 deleted the check-links-report-format branch September 11, 2026 22:19
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