Add `template` option to `changelog-github` by jycouet · Pull Request #2059 · changesets/changesets

jycouet · 2026-06-06T09:01:53Z

Reproduces @svitejs/changesets-changelog-github-compact (unmaintained) without the dependency.

Summary

Opt-in template option for @changesets/changelog-github. It lets it render compact changelog lines straight from .changeset/config.json. With template unset, output is byte-for-byte unchanged.

Reproduce the compact look:

"changelog": ["@changesets/changelog-github", {
  "repo": "<org>/<repo>",
  "template": "\n- {summary} {ref}"
}]

Tokens render bare (you write the surrounding spaces; empties self-erase and trailing whitespace is trimmed):

{summary} - first line, links every #n
{ref} - PR-xor-commit, parenthesized
{pr}, {commit} - the bare links
{authors} - contributor links (honors disableThanks); write the prefix yourself, e.g. Thanks {authors}!

Examples: template/output pairs live in the package README, each locked by a test so they can't drift.

Decisions

disableThanks stays. It is not deprecated and keeps working in template mode ({authors} honors it; you can also drop attribution by omitting {authors}). No back-compat break.
This stays in @changesets/changelog-github for now. Lifting templating into core (so every generator just contributes variables like {pr} / {commit} / {authors}) is a follow-up, not this PR. buildReleaseLineTokens is already shaped for that role and can move up later.

Potentially relevant issues / PRs

Refs are intentionally in backticks so this draft creates no cross-links.

Fully addressed

#538 - clickable issue links in CHANGELOG.md -> {summary}
#689 - dropping the "Thanks X" noise for solo maintainers -> omit {authors} / disableThanks
#1596 - customizing the per-release-line message -> template

Partially addressed (done / not done)

#1821 - templates: DONE = output changelog-line template; NOT = input changeset-file template (changeset add --template)
#1178 - modify the changelog format: DONE = per-line formatting; NOT = whole-file grouping / headers
#1057 - omit lines: DONE = per-line pieces (Thanks / PR / commit); NOT = removing section headers like "Patch Changes"
#1635 - shorter commit hash: DONE = changelog {commit} / {ref} (7-char); NOT = the snapshot prerelease version string
#1959 - override the default changelog formatter: DONE = per-line tokens; NOT = arbitrary PR tags / extra per-record metadata
#1248 - username links: DONE = drop attribution via {authors} / disableThanks; NOT = emitting plain unlinked @user for GitHub's Contributors section

Adjacent - not solved here

These need the headers/grouping or a deeper hook in apply-release-plan, not the changelog functions:

#1807 - changelog section titles
#995 - a getChangelogEntry hook for custom generators
#1204 - a contributors-acknowledgement section
#1332 - customizing generateChangesForVersionTypeMarkdown
#1127 / #1123 - a getVersionLine hook (version header line)

Related context

#1850 (merged) added linkifyIssueRefs; {summary} reuses it
#1255 (merged) added disableThanks; {authors} honors it (kept, see Decisions)
#1236 (merged) moved away from short commit IDs after a collision bug; this PR's {commit} / {ref} render 7-char hashes to match compact - flagging in case it needs revisiting
#1830 (open) adds a changelog-github README; if it lands, document these options there too (currently in config-file-options.md)

Verification

@changesets/changelog-github suite 56/56, types:check / lint / format clean. Existing snapshots unchanged (the back-compat guarantee).

changeset-bot · 2026-06-06T09:01:57Z

🦋 Changeset detected

Latest commit: 15d2c2d

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 · 2026-06-06T09:03:13Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.18%. Comparing base (dfefc4e) to head (15d2c2d).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2059      +/-   ##
==========================================
+ Coverage   86.04%   86.18%   +0.14%     
==========================================
  Files          70       71       +1     
  Lines        2558     2585      +27     
  Branches      692      703      +11     
==========================================
+ Hits         2201     2228      +27     
  Misses        330      330              
  Partials       27       27

☔ View full report in Codecov by Harness.
📢 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.

pomerantsev · 2026-06-22T02:38:38Z

It would be great to see this merged. I'd love to do less manual updating of my changelog entries for every release.

bluwy

I prefer if we mark or document the template option as experimental, and recommend pinning the version if used.

Right now there's things like:

If replacements like {authors} is empty, is going to leave an awkward Thanks ! rendered text. Similarly it doesn't handle conditional parenthesis and spaces.
{ref} has builtin parenthesis right now so it's easier to be compatible with -compact. I don't think it should have parenthesis builtin but we can leave it as is for now if we mark as experimental.
Eventually we should use renderTemplate for the default behaviour too. But it's not possible to handle the above right now without better templating syntax. So I'm ok with not doing this as well as long as it's experimental.

bluwy

The base branch needs to be updated to main as well. Shouldn't have any big conflicts by directly switching.

Opt-in. Lets changelog-github reproduce @svitejs/changesets-changelog-github-compact via config; default output unchanged.

…nts} token The linking choice now lives at the point of use in the template: {summary} links every #n, {summaryHints} links only (fix #n) hints. Drops the autolinkIssues option entirely.

…igration

…KEN_REGEX

….test.ts

trueberryless · 2026-06-25T20:19:32Z

Do we need a next-docs PR for this?

bluwy · 2026-06-26T01:04:23Z

Yeah we can do that after this is merged

# Conflicts: # docs/config-file-options.md

trueberryless

Sorry for the late review. I know you want to merge already. Just a small docs nitpick here:

Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com>

…ndefined-based links

jycouet · 2026-06-26T08:02:14Z

@Andarist conflics fixed 👍
I updated the PR description also to reflect latest changes

Maybe you will want to link later some issues properly (from PR description?) to notify them?

trueberryless

Amazing 😍
Everything LGTM 🚀

Thanks @jycouet for your wonderful contribution. I'm looking forward to playing around with this option!

This was referenced Jun 9, 2026

js template tentative jycouet/changesets#2

Closed

feat(changelog-github)!: add composeReleaseLine, remove disableThanks #2079

Closed

beeequeue approved these changes Jun 22, 2026

View reviewed changes

Andarist requested a review from bluwy June 25, 2026 06:56

bluwy requested changes Jun 25, 2026

View reviewed changes

Comment thread packages/changelog-github/src/index.ts Outdated

Comment thread packages/changelog-github/src/index.ts Outdated

Comment thread packages/changelog-github/src/index.ts Outdated

Comment thread docs/config-file-options.md Outdated

bluwy changed the title ~~feat(changelog-github): add template and autolinkIssues options~~ feat(changelog-github): add template option Jun 25, 2026

jycouet force-pushed the compact-next branch from 6f6d367 to 14e5305 Compare June 25, 2026 10:10

bluwy reviewed Jun 25, 2026

View reviewed changes

Comment thread packages/changelog-github/src/index.test.ts Outdated

Comment thread packages/changelog-github/src/index.ts Outdated

Comment thread packages/changelog-github/src/render-template.ts Outdated

bluwy reviewed Jun 25, 2026

View reviewed changes

Comment thread docs/config-file-options.md Outdated

jycouet added 10 commits June 25, 2026 20:20

feat(changelog-github): add template and autolinkIssues options

d3d7312

Opt-in. Lets changelog-github reproduce @svitejs/changesets-changelog-github-compact via config; default output unchanged.

feat(changelog-github): replace autolinkIssues option with {summaryHi…

cad940f

…nts} token The linking choice now lives at the point of use in the template: {summary} links every #n, {summaryHints} links only (fix #n) hints. Drops the autolinkIssues option entirely.

chore: update changeset

8ed39a2

refactor(changelog-github): move template helpers to render-template.ts

ae3bfb7

refactor(changelog-github): rename {pr} template token to {pull}

31daf6c

refactor(changelog-github): drop {summaryHints} token, link all refs

8a79c35

docs(changelog-github): mark template as experimental, drop compact m…

4218e8f

…igration

refactor(changelog-github): rename regex consts to ISSUE_REF_REGEX/TO…

de7dde0

…KEN_REGEX

test(changelog-github): move template helper tests to render-template…

c59b3b9

….test.ts

docs(changelog-github): move template option docs into package README

7d4cf88

jycouet force-pushed the compact-next branch from 14e5305 to 7d4cf88 Compare June 25, 2026 18:22

jycouet requested review from Andarist and emmatown as code owners June 25, 2026 18:22

jycouet changed the base branch from next to main June 25, 2026 18:22

Andarist requested a review from bluwy June 25, 2026 20:02

bluwy approved these changes Jun 26, 2026

View reviewed changes

Andarist changed the title ~~feat(changelog-github): add template option~~ Add template option to changelog-github Jun 26, 2026

Andarist added this pull request to the merge queue Jun 26, 2026

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jun 26, 2026

Andarist and others added 2 commits June 26, 2026 09:09

Merge remote-tracking branch 'origin/main' into compact-next

4e5a538

Merge remote-tracking branch 'origin/main' into compact-next

beb0713

# Conflicts: # docs/config-file-options.md

trueberryless reviewed Jun 26, 2026

View reviewed changes

Comment thread packages/changelog-github/README.md Outdated

jycouet and others added 2 commits June 26, 2026 09:58

users -> authors

241f7de

Co-authored-by: Felix Schneider <99918022+trueberryless@users.noreply.github.com>

fix(changelog-github): align buildReleaseLineTokens link types with u…

15d2c2d

…ndefined-based links

trueberryless approved these changes Jun 26, 2026

View reviewed changes

bluwy added this pull request to the merge queue Jun 26, 2026

Merged via the queue into changesets:main with commit 070f531 Jun 26, 2026
12 checks passed

changesets-org-version-bot Bot mentioned this pull request Jun 26, 2026

Version Packages (next) #2122

Merged

trueberryless mentioned this pull request Jun 26, 2026

docs: create page for GitHub generator package #2127

Merged

benmccann mentioned this pull request Jul 21, 2026

Native monorepo versioning: implementation plan (RFC pnpm/rfcs PR 18) pnpm/pnpm#12952

Open

Uh oh!

Uh oh!

Conversation

jycouet commented Jun 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Decisions

Potentially relevant issues / PRs

Fully addressed

Partially addressed (done / not done)

Adjacent - not solved here

Related context

Verification

Uh oh!

changeset-bot Bot commented Jun 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

codecov Bot commented Jun 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pomerantsev commented Jun 22, 2026

Uh oh!

bluwy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bluwy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

trueberryless commented Jun 25, 2026

Uh oh!

bluwy commented Jun 26, 2026

Uh oh!

Uh oh!

trueberryless left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jycouet commented Jun 26, 2026

Uh oh!

trueberryless left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jycouet commented Jun 6, 2026 •

edited

Loading

changeset-bot Bot commented Jun 6, 2026 •

edited

Loading

codecov Bot commented Jun 6, 2026 •

edited

Loading