Skip to content

ci: backport relative docs redirects and the removed-route check to 2.38 - #30806

Closed
nickvigilante wants to merge 1 commit into
release/2.38from
vigilante/docs-2.38-redirects
Closed

nickvigilante wants to merge 1 commit into
release/2.38from
vigilante/docs-2.38-redirects

Conversation

@nickvigilante

Copy link
Copy Markdown
Collaborator

Summary

Backports #30805 to release/2.38 with 2.38's own docs/redirects.json, so the mainline docs (coder.com/docs and coder.com/beta-docs, currently v2.38) get their redirects from this branch.

Part of DOCS-1290; tracked in DOCS-1292.

Changes

  • scripts/docsredirectscheck and its lint/docs-redirects Make target, wired into lint and lint-light. This branch had no checker before.
  • deploy-docs.yaml: the redirects rebuild signal from docs: add redirects.json and rebuild the docs site when it changes #30208, so a change to only docs/redirects.json here triggers the coder.com rebuild.
  • docs/redirects.json: 311 rules built from coder.com's unversioned docs content rules, with URL-scheme rules (v1, v2, coder-oss, coder/, code-server) left in coder.com.
    Changes from coder.com's versions:
    • about/architecture goes to /.
    • The retired security advisory goes to GitHub Security Advisories, since its old blob URL returns 404.
    • contributing/* is replaced by 9 exact rules, since about/contributing has no pages.
  • Contributor guidance updated to the relative format.

Testing

  • go test ./scripts/docsredirectscheck/... and the pre-commit hook.
  • go run ./scripts/docsredirectscheck -base origin/release/2.38 -branch release/2.38 online: 311 rules OK, 464 routes resolve.
  • curl on all 10 external destinations: 200.

Merge order

Merge after #30805 and after the coder.com generator is deployed.

Note

Generated by Coder Agents on behalf of @nickvigilante.

Backport the docsredirectscheck rewrite from main: relative routes,
/* wildcards, and a blocking removed-route check against the base
manifest, the live page list for the target branch, and base redirect
sources. Wire it into lint and lint-light.

Add docs/redirects.json for this branch from the unversioned docs rules
that coder.com carries today, resolved to pages that exist in 2.38.
Point the contributor docs at docs/redirects.json instead of the
coder.com repo.

Generated with Coder Agents.
@linear-code

linear-code Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

DOCS-1290

DOCS-1292

@github-actions

Copy link
Copy Markdown
Contributor

👋 Hey @nickvigilante!

This PR is targeting the release/2.38 release branch, but its title does not start with fix: or fix(scope):.

Only bug fixes should be cherry-picked to release branches. If this is a bug fix, please update the PR title to match the conventional commit format:

fix: description of the bug fix
fix(scope): description of the bug fix

If this is not a bug fix, it likely should not target a release branch.

@nickvigilante

Copy link
Copy Markdown
Collaborator Author

Closing. release/2.39 was cut on 2026-10-30, so 2.38 stops being the mainline once 2.39 ships. The redirects change will be backported to release/2.39 after #30805 merges instead.

Generated by Coder Agents on behalf of @nickvigilante.

@github-actions github-actions Bot locked and limited conversation to collaborators Nov 2, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant