Skip to content

build: drop the link check from the Vercel build; it runs as its own PR check - #1960

Open
marcleblanc2 wants to merge 1 commit into
mainfrom
marc/build/no-link-check
Open

marcleblanc2 wants to merge 1 commit into
mainfrom
marc/build/no-link-check

Conversation

@marcleblanc2

Copy link
Copy Markdown
Contributor

Why

Since #1858, dev/check-links.mjs runs twice on every PR:

  • the Broken links introduced by this PR job (.github/workflows/check-links.yml), with --check-anchors --check-self-links --check-external, a baseline of main so only links the PR introduces are reported, and a PR comment with the findings
  • again with no flags inside npm run build, so a dead link anywhere in the tree fails the Vercel deploy, including links the commit did not touch

The PR check is the one that reports and gates; the build copy only duplicates it and can block a deploy without telling anyone which link is at fault (Vercel build logs are team-only, see dev/report-vercel-build.mjs).

What

npm run build now runs node dev/checks.mjs filenames images; the links check is no longer part of the build. npm run check still runs all three checks, and npm run check -- links … is unchanged. Comments in dev/checks.mjs, dev/check-links.mjs, and AGENTS.md updated to match.

Verification

  • node dev/checks.mjs filenames images → exit 0, only the filename and image checks run
  • node dev/checks.mjs → all three checks run
  • Planted [dead](/no/such/page) in docs/index.mdx: build prefix exits 0, node dev/checks.mjs links exits 1
  • pnpm build runs the new prefix, generates mermaid icons, and enters next build (the Vercel preview on this PR completes the rest)

…PR check

The Broken links introduced by this PR job (.github/workflows/check-links.yml)
runs dev/check-links.mjs on every pull request, with a baseline so it only
reports links the PR introduces, and comments the findings. Running it again
without flags in npm run build duplicated that check and made a dead link
anywhere in the tree fail the deploy, even one not introduced by the commit.

npm run build now runs only the filenames and images checks. npm run check
still runs all three.

Amp-Thread-ID: https://ampcode.com/threads/T-01a09f23-2ad6-76a8-a697-3da4969f29f9
Co-authored-by: Amp <amp@ampcode.com>
@vercel

vercel Bot commented Sep 14, 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 14, 2026 3:51pm UTC

Request Review

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