feat(Infra) if a file was moved, ensure there is a redirect
DESCRIBE YOUR PR
Problem
When MDX files are renamed or moved, contributors sometimes forget to add corresponding redirects to redirects.js, causing broken links for old URLs.
Solution
Added a GitHub Action workflow that automatically detects MDX file renames in PRs and checks if the necessary redirects exist in redirects.js. If redirects are missing, it posts a warning comment on the PR with code snippets showing exactly what redirects to add.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
- [ ] Urgent deadline (GA date, etc.):
- [ ] Other deadline:
- [ ] None: Not urgent, can wait up to 1 week+
SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts)
- [ ] PR was reviewed and approved by a member of the Sentry docs team
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES
The latest updates on your projects. Learn more about Vercel for GitHub.
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| develop-docs | Preview | Comment | Nov 4, 2025 9:01pm | |
| sentry-docs | Preview | Comment | Nov 4, 2025 9:01pm |
Bundle Report
Changes will increase total bundle size by 6.78kB (0.03%) :arrow_up:. This is within the configured threshold :white_check_mark:
Detailed changes
| Bundle name | Size | Change |
|---|---|---|
| sentry-docs-client-array-push | 10.16MB | -6 bytes (-0.0%) :arrow_down: |
| sentry-docs-server-cjs | 12.85MB | 6.78kB (0.05%) :arrow_up: |
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
| Asset Name | Size Change | Total Size | Change (%) |
|---|---|---|---|
static/chunks/pages/_app-*.js |
-3 bytes | 882.71kB | -0.0% |
static/chunks/8321-*.js |
-3 bytes | 425.87kB | -0.0% |
static/0n7dY6mdA38xM1nZ3pRY_/_buildManifest.js (New) |
684 bytes | 684 bytes | 100.0% :rocket: |
static/0n7dY6mdA38xM1nZ3pRY_/_ssgManifest.js (New) |
77 bytes | 77 bytes | 100.0% :rocket: |
~~static/UsUQQxHGmYSA7AWawkYFs/_buildManifest.js~~ (Deleted) |
-684 bytes | 0 bytes | -100.0% :wastebasket: |
~~static/UsUQQxHGmYSA7AWawkYFs/_ssgManifest.js~~ (Deleted) |
-77 bytes | 0 bytes | -100.0% :wastebasket: |
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
| Asset Name | Size Change | Total Size | Change (%) |
|---|---|---|---|
1729.js |
-3 bytes | 1.74MB | -0.0% |
../instrumentation.js |
-3 bytes | 1.07MB | -0.0% |
9523.js |
-3 bytes | 1.04MB | -0.0% |
../app/[[...path]]/page.js.nft.json |
2.26kB | 849.9kB | 0.27% |
../app/platform-redirect/page.js.nft.json |
2.26kB | 849.82kB | 0.27% |
../app/sitemap.xml/route.js.nft.json |
2.26kB | 847.05kB | 0.27% |
⚠️ Missing Redirects Detected
This PR renames or moves MDX files, but some redirects may be missing from redirects.js.
Please add the following redirects to ensure old URLs continue to work:
Developer Docs Redirects (developerDocsRedirects array)
{
source: '/development-infrastructure/testing/',
destination: '/development-infrastructure/testing-new/',
},
Note: This check will fail until redirects are added. Adding redirects ensures old links continue to work.
What's the best way to verify that this works? Is it worth including some tests?
@coolguyzone
yeah there is a scripts/check-redirects-on-rename.spec.ts and i tested manually by changing renaming a file and it triggered a comment, not sure how else to test, open to suggestions!