Skip to content

feat(changelog-github): linkify issue references in changelog entries#1850

Merged
Andarist merged 7 commits intochangesets:mainfrom
mixelburg:feat/changelog-linkify-issue-refs
Feb 23, 2026
Merged

feat(changelog-github): linkify issue references in changelog entries#1850
Andarist merged 7 commits intochangesets:mainfrom
mixelburg:feat/changelog-linkify-issue-refs

Conversation

@mixelburg
Copy link
Contributor

Problem

When changeset summaries contain issue references like #1234, they render as clickable links in GitHub PR descriptions but appear as plain text in the generated CHANGELOG.md (#538).

Solution

Added a post-processing step in getReleaseLine that converts plain #<number> references into proper markdown links pointing to the repo's issues page. References that are already inside markdown links are skipped to avoid double-linkification.

The links use the configured repo option and GITHUB_SERVER_URL environment variable, consistent with how PR and commit links are generated.

Tests

Added two tests:

  • Verifies issue references are converted to links
  • Verifies existing markdown links are not double-linkified

All existing tests continue to pass.

Fixes #538

Converts plain changesets#1234 references in changeset summaries into clickable
GitHub links in the generated CHANGELOG.md. References that are already
part of markdown links are left unchanged.

Uses the configured repo and GITHUB_SERVER_URL for link generation.

Fixes changesets#538
@changeset-bot
Copy link

changeset-bot bot commented Feb 19, 2026

🦋 Changeset detected

Latest commit: cbcb5dd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@changesets/changelog-github Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.22%. Comparing base (e07fd62) to head (cbcb5dd).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1850      +/-   ##
==========================================
- Coverage   81.33%   81.22%   -0.11%     
==========================================
  Files          54       55       +1     
  Lines        2277     2333      +56     
  Branches      679      690      +11     
==========================================
+ Hits         1852     1895      +43     
- Misses        420      433      +13     
  Partials        5        5              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

line: string,
{ serverUrl, repo }: { serverUrl: string; repo: string }
): string {
return line.replace(/\[.*?\]\(.*?\)|\B#([1-9]\d*)\b/g, (match, issue) =>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kicking the remark-github can further down the road 😉

@Andarist Andarist merged commit fd0bc2e into changesets:main Feb 23, 2026
3 checks passed
@github-actions github-actions bot mentioned this pull request Feb 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clickable issue links in CHANGELOG.md

2 participants