Add recipe for remapping GitHub URLs to a commit - #159
Merged
Conversation
Documents how to use --remap so links to files that only exist on a feature branch pass CI link checks, by rewriting default-branch URLs to the checked commit (the merge commit in PR workflows). Closes #144.
katrinafyi
approved these changes
Jun 7, 2026
katrinafyi
left a comment
katrinafyi
left a comment
Member
There was a problem hiding this comment.
Quite happy with this, thanks @mre !
Member
Author
|
Thanks. At some point we still should think about restructuring our docs (#143), but it's probably best to not make this a blocker and merge in the changes as we go to help more users. :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a docs recipe explaining how to use
--remapso links to files that only exist on a feature branch pass CI link checks.It rewrites default-branch GitHub URLs (e.g.
/blob/main) to the commit being checked — the merge commit in pull request workflows — so a not-yet-merged file resolves, while deleted or moved files are still correctly flagged. Includes a copy-pasteable GitHub Actions example usinggithub.shaandgithub.repository.Closes #144.