feat: add PR link checking workflow and fix links by bjohansebas · Pull Request #2192 · expressjs/expressjs.com

bjohansebas · 2026-02-21T23:16:49Z

After asking for some feedback on the Astro Discord about a link checker, they recommended https://github.com/lycheeverse/lychee for this task. They also recommended https://github.com/HiDeoo/starlight-links-validator, but it seems it only works with Starlight.

closes #1100

netlify · 2026-02-21T23:16:54Z

✅ Deploy Preview for expressjscom-preview ready!

Name	Link
🔨 Latest commit	`77d2f45`
🔍 Latest deploy log	https://app.netlify.com/projects/expressjscom-preview/deploys/69b719c81f32c50008c6dace
😎 Deploy Preview	https://deploy-preview-2192--expressjscom-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 100 (🟢 up 4 from production) Accessibility: 100 (🟢 up 13 from production) Best Practices: 100 (no change from production) SEO: 100 (🟢 up 6 from production) PWA: 80 (🟢 up 50 from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

…into link-check

socket-security · 2026-03-12T14:14:16Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Package	Supply Chain Security	Quality	Maintenance
npm/@iconify-json/fluent@1.2.38 ⏵ 1.2.40			⁺¹
npm/@types/node@25.3.2 ⏵ 25.4.0	⁺¹	⁺¹
npm/@astrojs/mdx@4.3.13 ⏵ 4.3.14			⁺¹
npm/globals@17.4.0
npm/eslint-plugin-astro@1.5.0 ⏵ 1.6.0	^-1		⁺⁵
npm/astro@5.18.0 ⏵ 5.18.1			⁺¹
npm/eslint@9.39.2 ⏵ 9.39.4	⁺¹
npm/postcss-custom-media@12.0.0 ⏵ 12.0.1			⁺⁴
npm/@eslint/js@9.39.2 ⏵ 9.39.4
npm/lint-staged@16.2.7 ⏵ 16.3.3	⁺¹		⁺⁸

View full report

… URLs

…ioned slugs

…duction

…sh content

…into link-check

Copilot

Pull request overview

Adds automated link checking via Lychee and updates many internal/external documentation links to match the new route structure, while also introducing an api content collection for Astro.

Changes:

Add a GitHub Actions job to build the Astro site and run Lychee link checks.
Normalize many docs/blog/API links (e.g., removing .html, switching to /en/... paths, updating anchors, switching to HTTPS).
Add an Astro content collection for API docs and scaffold new API index/overview pages.

Reviewed changes

Copilot reviewed 94 out of 831 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
astro/src/content/docs/de/4x/api/application/app-use.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-set.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-onmount.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-get.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-get-method.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-disabled.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-disable.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/api/application/app-delete-method.md	Removes German 4x app API doc page.
astro/src/content/docs/de/4x/advanced/security-updates.md	Fixes absolute links to stable `/en/...` routes.
astro/src/content/docs/de/4x/advanced/best-practice-security.md	Updates links + section anchor references and one external URL.
astro/src/content/docs/de/4x/advanced/best-practice-performance.md	Updates several external links/anchors.
astro/src/content/docs/de/3x/api.md	Fixes `/support` link URL.
astro/src/content/blog/en/write-post.md	Adds author guide page for writing blog posts.
astro/src/content/blog/en/2025-03-31-v5-1-latest-release.md	Replaces absolute URLs with internal routes.
astro/src/content/blog/en/2025-01-09-rewind-2024-triumphs-and-2025-vision.md	Replaces absolute URLs with internal routes.
astro/src/content/blog/en/2024-10-22-security-audit-milestone-achievement.md	Replaces absolute URL with internal route.
astro/src/content/blog/en/2024-10-15-v5-release.md	Adds TOC items + normalizes internal links/anchors.
astro/src/content/blog/en/2024-07-16-welcome-post.md	Fixes internal link route for write-post.
astro/src/content/api/5x/api/response/res-status.md	Switches Node docs link to HTTPS.
astro/src/content/api/5x/api/response/res-render.md	Updates template-engine guide link to `/en/...` route.
astro/src/content/api/5x/api/response/res-redirect.md	Fixes RFC anchor + security link anchor format.
astro/src/content/api/5x/api/response/res-jsonp.md	Replaces in-page anchor with absolute app-settings link.
astro/src/content/api/5x/api/request/req-subdomains.md	Updates app.set link to `/en/5x/api#...`.
astro/src/content/api/5x/api/request/req-query.md	Replaces `#app.settings.table` anchors with app-settings page links.
astro/src/content/api/5x/api/request/req-path.md	Updates app.use link to `/en/5x/api#...`.
astro/src/content/api/5x/api/request/req-params.md	Updates routing/app.param links to `/en/...` routes.
astro/src/content/api/5x/api/request/req-ips.md	Updates `trust proxy` link to `/en/5x/api#...`.
astro/src/content/api/5x/api/request/req-ip.md	Updates `trust proxy` link to `/en/5x/api#...`.
astro/src/content/api/5x/api/request/req-hostname.md	Updates `trust proxy` link to `/en/5x/api#...`.
astro/src/content/api/5x/api/request/req-host.md	Fixes broken relative link to trust proxy setting.
astro/src/content/api/5x/api/express/express.urlencoded.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/5x/api/express/express.text.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/5x/api/express/express.static.md	Updates middleware/perf links to `/en/...` routes.
astro/src/content/api/5x/api/express/express.raw.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/5x/api/express/express.json.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/5x/api/application/overview.md	Points “Application settings” to app-settings page.
astro/src/content/api/5x/api/application/app-use.md	Normalizes several guide/app-settings links.
astro/src/content/api/5x/api/application/app-settings.md	Updates perf/behind-proxies links to `/en/...` routes.
astro/src/content/api/5x/api/application/app-set.md	Links app settings table to app-settings page.
astro/src/content/api/5x/api/application/app-post-method.md	Normalizes routing guide link.
astro/src/content/api/5x/api/application/app-param.md	Normalizes routing guide anchor link.
astro/src/content/api/5x/api/application/app-onmount.md	Updates “Application settings” link.
astro/src/content/api/5x/api/application/app-get.md	Links app settings table to app-settings page.
astro/src/content/api/5x/api/application/app-get-method.md	Normalizes routing guide link.
astro/src/content/api/5x/api/application/app-enabled.md	Links app settings table to app-settings page.
astro/src/content/api/5x/api/application/app-enable.md	Links app settings table to app-settings page.
astro/src/content/api/5x/api/application/app-disabled.md	Links app settings table to app-settings page.
astro/src/content/api/5x/api/application/app-disable.md	Links app settings table to app-settings page.
astro/src/content/api/5x/api/application/app-delete-method.md	Normalizes routing guide link.
astro/src/content/api/5x/api/application/app-METHOD.md	Normalizes routing guide link.
astro/src/content/api/5x/api.md	Adds (placeholder) top-level API page for 5x.
astro/src/content/api/4x/api/response/res-status.md	Switches Node docs link to HTTPS.
astro/src/content/api/4x/api/response/res-render.md	Updates template-engine guide link to `/en/...` route.
astro/src/content/api/4x/api/response/res-redirect.md	Fixes RFC anchor + security link anchor format.
astro/src/content/api/4x/api/response/res-location.md	Fixes security link anchor format.
astro/src/content/api/4x/api/response/res-jsonp.md	Replaces in-page anchor with absolute app-settings link.
astro/src/content/api/4x/api/request/req-subdomains.md	Updates app.set link to `/en/4x/api#...`.
astro/src/content/api/4x/api/request/req-query.md	Replaces `#app.settings.table` anchors with app-settings page links.
astro/src/content/api/4x/api/request/req-path.md	Updates app.use link to `/en/4x/api#...`.
astro/src/content/api/4x/api/request/req-params.md	Updates routing/app.param links to `/en/...` routes.
astro/src/content/api/4x/api/request/req-ips.md	Updates `trust proxy` link to `/en/4x/api#...`.
astro/src/content/api/4x/api/request/req-ip.md	Updates `trust proxy` link to `/en/4x/api#...`.
astro/src/content/api/4x/api/request/req-hostname.md	Updates `trust proxy` link to `/en/4x/api#...`.
astro/src/content/api/4x/api/express/express.urlencoded.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/4x/api/express/express.text.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/4x/api/express/express.static.md	Updates middleware/perf links to `/en/...` routes.
astro/src/content/api/4x/api/express/express.raw.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/4x/api/express/express.json.md	Updates middleware doc link to `/en/...` route.
astro/src/content/api/4x/api/application/overview.md	Points “Application settings” to app-settings page.
astro/src/content/api/4x/api/application/app-use.md	Normalizes several guide/app-settings links.
astro/src/content/api/4x/api/application/app-settings.md	Updates perf/behind-proxies links to `/en/...` routes.
astro/src/content/api/4x/api/application/app-set.md	Links app settings table to app-settings page.
astro/src/content/api/4x/api/application/app-post-method.md	Normalizes routing guide link.
astro/src/content/api/4x/api/application/app-param.md	Normalizes routing guide anchor link.
astro/src/content/api/4x/api/application/app-onmount.md	Updates “Application settings” link.
astro/src/content/api/4x/api/application/app-get.md	Links app settings table to app-settings page.
astro/src/content/api/4x/api/application/app-get-method.md	Normalizes routing guide link.
astro/src/content/api/4x/api/application/app-enabled.md	Links app settings table to app-settings page.
astro/src/content/api/4x/api/application/app-enable.md	Links app settings table to app-settings page.
astro/src/content/api/4x/api/application/app-disabled.md	Links app settings table to app-settings page.
astro/src/content/api/4x/api/application/app-disable.md	Links app settings table to app-settings page.
astro/src/content/api/4x/api/application/app-delete-method.md	Normalizes routing guide link.
astro/src/content/api/4x/api/application/app-METHOD.md	Normalizes routing guide link.
astro/src/content/api/4x/api.md	Adds (placeholder) top-level API page for 4x.
astro/src/content/api/3x/api/response/overview.md	Adds placeholder response overview page.
astro/src/content/api/3x/api.md	Adds top-level 3x API page with includes and EOL warning.
astro/src/content.config.ts	Adds `api` content collection.
astro/src/config/menu/middleware.ts	Removes connect-rid menu entry (likely broken link).
astro/package.json	Adds `globals` dependency (eslint globals config).
astro/eslint.config.js	Uses `globals` + `globalIgnores` for ESLint flat config.
astro/astro.config.mjs	Sets `site` dynamically for Netlify preview deployments.
astro/CONTRIBUTING.md	Updates contributing page URL format.
astro/.lycheeignore	Adds ignore rules to reduce rate limiting / false positives.
.github/workflows/build.yml	Adds linkChecker job using lychee-action.

Comments suppressed due to low confidence (1)

astro/src/content/api/4x/api/response/res-jsonp.md:1

This absolute link is missing the locale prefix (/en/...) and (based on other updates) likely also needs the version segment (/4x/... or /5x/...). As written it’s likely to 404. Prefer linking to the correct versioned app-settings page under the same API version, and keep the locale consistent with surrounding links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

astro/.lycheeignore

astro/src/content/api/4x/api/application/app-set.md

astro/src/content/api/5x/api.md

+title: 4x API Reference
+description: API Reference for version 4.x
+---
+
+# 4.x API


astro/src/content/api/3x/api/response/overview.md

+---
+title: API Response Overview
+description: An overview of the API response object in Express.js, detailing its properties and methods for
+---
+
+TODO


astro/src/content/api/3x/api.md

@@ -0,0 +1,25 @@
+---
+title: Express 3.x - Referencia de API


astro/astro.config.mjs

+
+const site = NETLIFY_PREVIEW_SITE || 'https://expressjs.com';
+
+// TODO: add redirecto for blog posts


astro/eslint.config.js


 export default [
  // Global ignores
+  globalIgnores(['dist/*', '.astro/*', 'node_modules/*', 'package-lock.json']),


.github/workflows/build.yml

+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6


bjohansebas · 2026-03-15T20:54:49Z

Okay @g-francesca and @expressjs/docs-wg, this is a pretty huge PR (something I wanted to avoid) and I'm going to merge it because I need it to unblock my next changes.

The most important thing to keep in mind about these changes is that the API now has its own Astro collection. It is no longer tied to the docs collection where everything was versioned and had i18n. Instead, the API is now only in the API collection, with no i18n.

I also added a fallback for pages that don't have a translation yet, pointing directly to the English version. This helps avoid a lot of 404s right now, since otherwise I wouldn't be able to keep moving forward. And honestly, I quite like the fallback :)

I know there are links between API pages that point to the wrong version; that will be fixed in #2193.

If you find any problems, feel free to open a PR to fix them or open an issue.

bjohansebas requested a review from a team as a code owner February 21, 2026 23:16

bjohansebas force-pushed the link-check branch from 7871870 to df85434 Compare February 21, 2026 23:27

feat: add PR link checking workflow

8e1ce67

bjohansebas force-pushed the link-check branch from df85434 to 8e1ce67 Compare February 21, 2026 23:27

bjohansebas mentioned this pull request Feb 22, 2026

feat: add remark plugin to rewrite localized links in Markdown content #2193

Draft

fixup!: fix ci

5c679fa

bjohansebas force-pushed the link-check branch from fb64e0c to 5c679fa Compare February 22, 2026 14:00

bjohansebas added 5 commits February 22, 2026 14:09

fix: update build step configuration in PR link checker workflow

69ea867

fix: update package manager version in PR link checker workflow

7ce356a

fix: update working directory for link checking in PR workflow

14d0153

fix: update Node.js setup and build steps in PR link checker workflow

38c87e2

Merge branch 'redesign' of https://github.com/expressjs/expressjs.com …

aa2df88

…into link-check

bjohansebas added 11 commits March 12, 2026 14:24

fix: update site configuration to use dynamic Netlify preview URL

355a540

fix: update link checker arguments to include src directory and remap…

0d967c3

… URLs

only check dist

013a53a

i18n: include resource pages

c0844c7

i18n: don't translate api

3abdb36

fix: enhance static path generation for API pages and handle non-vers…

49d35c2

…ioned slugs

feat: add performance best practices documentation for Express in pro…

829d1c1

…duction

fix: add fallback for non-versioned default-version slugs using Engli…

9495c31

…sh content

docs: add API Response Overview documentation

1e54797

chore: add .lycheeignore to exclude dynamic language links

e96a629

fix links

ac3ce51

bjohansebas changed the title ~~feat: add PR link checking workflow~~ feat: add PR link checking workflow and fix links Mar 13, 2026

bjohansebas added 4 commits March 13, 2026 14:03

fix: update link checker to handle .html remapping

ee75b7e

fix: update link remapping in link checker and enhance .lycheeignore

cdbff34

fix: update link remapping in link checker for index.html handling

a51a94e

fix links

7553604

bjohansebas added 25 commits March 15, 2026 18:06

Merge branch 'redesign' of https://github.com/expressjs/expressjs.com …

f206899

…into link-check

fix links!

08f668b

fix links!

f4d2b3c

fixup link!

2edd640

add missing page

b3f4e06

fix links in blog post and add TODO for blog post redirects

f1e68e3

fixup links!

1a4cc0d

update links to app settings documentation across multiple API files

763c48a

temporal remove logos

043e2cd

fix: update link to technical committee in contributing guide

2a97da7

fix link issues

429a4e4

fix links!

06cccc8

fix linter config

360d26f

fix link!

0678815

update ignore links!

02a2b43

fix links

2a90d62

add link checker workflow and remove old PR links workflow

56be59a

fix link to technical committee in contributing guide

528ae9c

missing ignore for 404

079ef13

fix more links!

99c9a3a

fix link to technical committee in contributing guide

d66bf82

fix more links

e4bb6a8

remove connect-id

dd2325e

remove connect-rid of menu

1d4a792

update .lycheeignore to include npmjs.com and Open Collective links

77d2f45

bjohansebas requested a review from Copilot March 15, 2026 20:48

Copilot AI reviewed Mar 15, 2026

View reviewed changes

bjohansebas merged commit 5e8ed6a into redesign Mar 15, 2026
12 checks passed

bjohansebas deleted the link-check branch March 15, 2026 20:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add PR link checking workflow and fix links#2192

feat: add PR link checking workflow and fix links#2192
bjohansebas merged 52 commits intoredesignfrom
link-check

bjohansebas commented Feb 21, 2026 •

edited

Loading

Uh oh!

netlify bot commented Feb 21, 2026 •

edited

Loading

Uh oh!

socket-security bot commented Mar 12, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

bjohansebas commented Mar 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		const site = NETLIFY_PREVIEW_SITE \|\| 'https://expressjs.com';

		// TODO: add redirecto for blog posts

Uh oh!

Conversation

bjohansebas commented Feb 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Feb 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for expressjscom-preview ready!

Uh oh!

socket-security bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

bjohansebas commented Mar 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bjohansebas commented Feb 21, 2026 •

edited

Loading

netlify bot commented Feb 21, 2026 •

edited

Loading

socket-security bot commented Mar 12, 2026 •

edited

Loading