fix: Don't mention PRs to avoid linking in changelog previews #712
+18
−10
Conversation
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
The changelog preview was creating markdown links to PRs like [#123](url), which caused GitHub to automatically post a comment on each mentioned PR saying it was referenced. This was noisy since the PRs don't usually have anything in common other than being in the same release. This change adds a `disablePRLinks` parameter that formats PR references using backticks (`#123`) instead of markdown links, preventing GitHub from auto-linking and creating cross-references. The fix is applied specifically to the changelog preview feature (used in the GitHub Actions workflow) by passing `disablePRLinks: true` when calling `serializeChangelog()` from `generateChangelogWithHighlight()`. Regular changelog generation (for actual releases) continues to use full markdown links as before. Fixes #78da
Contributor
|
Cursor Agent can help with this pull request. Just |
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. Bug Fixes 🐛
🤖 This preview updates automatically when you update the PR. |
This was referenced Jan 13, 2026
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Disable PR links in changelog previews to prevent unwanted GitHub cross-references.
The changelog preview feature (e.g.,
craft changelog --pr) was generating markdown links for PRs, which caused GitHub to create cross-reference notifications on those PRs. This change formats PR numbers as plain backticked text (e.g.,`#123`) in previews, avoiding the unwanted notifications while keeping full links for actual release changelogs.Fixes #711