mirror of
https://github.com/coder/coder.git
synced 2026-09-21 12:44:32 +08:00
ci(docs): rewrite same-repo links to PR head SHA in linkspector (#22995)
When a PR introduces new files and docs link to them via github.com/coder/coder/blob/main/..., linkspector returns 404 because the files don't exist on main yet. Add a step that, for PR events only, appends replacementPatterns to the linkspector config rewriting blob/main/ and tree/main/ URLs to use the PR's head commit SHA. Refs #22922
This commit is contained in:
@@ -30,6 +30,22 @@ jobs:
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Rewrite same-repo links for PR branch
|
||||
if: github.event_name == 'pull_request'
|
||||
env:
|
||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
||||
run: |
|
||||
# Rewrite same-repo blob/tree main links to the PR head SHA
|
||||
# so that files or directories introduced in the PR are
|
||||
# reachable during link checking.
|
||||
{
|
||||
echo 'replacementPatterns:'
|
||||
echo " - pattern: \"https://github.com/coder/coder/blob/main/\""
|
||||
echo " replacement: \"https://github.com/coder/coder/blob/${HEAD_SHA}/\""
|
||||
echo " - pattern: \"https://github.com/coder/coder/tree/main/\""
|
||||
echo " replacement: \"https://github.com/coder/coder/tree/${HEAD_SHA}/\""
|
||||
} >> .github/.linkspector.yml
|
||||
|
||||
- name: Check Markdown links
|
||||
uses: umbrelladocs/action-linkspector@652f85bc57bb1e7d4327260decc10aa68f7694c3 # v1.4.0
|
||||
id: markdown-link-check
|
||||
|
||||
Reference in New Issue
Block a user