Skip to content

devex: changelog system#5309

Merged
IMB11 merged 17 commits intomainfrom
cal/changelog-improvements
Mar 23, 2026
Merged

devex: changelog system#5309
IMB11 merged 17 commits intomainfrom
cal/changelog-improvements

Conversation

@IMB11
Copy link
Copy Markdown
Member

@IMB11 IMB11 commented Feb 6, 2026

We really suck at changelogs - we should be documenting everything we do - this will encourage it.

How it works

1. PR is opened

A GitHub Actions workflow (changelog-comment.yml) posts a comment with a Keep a Changelog template. Each product area (App, Website, Hosting) gets its own collapsible <details> section, so a single PR can document different changes for different products.

If the PR targets another PR's branch (child PR), the bot adds an admonition linking to the parent PR.

2. Author fills in the comment

The author edits the bot comment, expanding the relevant product sections and writing bullet points under the standard headings (Added, Changed, Deprecated, Removed, Fixed, Security). Empty sections and products are ignored.

3. Collecting changelogs

Before deploying mainprod, run:

pnpm changelog:collect
# If app entries exist:
pnpm changelog:collect -- --version X.Y.Z
# Preview without writing:
pnpm changelog:collect -- --dry-run

The script:

  • Finds all PRs merged into main since the last prod commit
  • Parses each PR's bot comment using keep-a-changelog
  • Auto-links #issue references to GitHub
  • Groups entries by product and inserts into packages/blog/changelog.ts - can edit before committing to main to polish/QA
  • Marks processed comments with a "baked" admonition

Uses GITHUB_TOKEN env var, or falls back to gh auth token.

@IMB11 IMB11 requested a review from a team February 6, 2026 13:45
@IMB11 IMB11 added the dev-ex Improvements to developer experience label Feb 6, 2026
@IMB11 IMB11 marked this pull request as draft February 6, 2026 13:45
@IMB11 IMB11 marked this pull request as ready for review February 6, 2026 13:54
@modrinth modrinth deleted a comment from github-actions bot Mar 19, 2026
@modrinth modrinth deleted a comment from modrinth-bot Mar 19, 2026
@modrinth modrinth deleted a comment from github-actions bot Mar 19, 2026
@modrinth modrinth deleted a comment from github-actions bot Mar 20, 2026
@IMB11 IMB11 requested a review from a team March 20, 2026 01:03
@IMB11 IMB11 marked this pull request as draft March 21, 2026 16:36
@modrinth modrinth deleted a comment from modrinth-bot Mar 21, 2026
@modrinth modrinth deleted a comment from github-actions bot Mar 21, 2026
@cloudflare-workers-and-pages

This comment was marked as off-topic.

@modrinth-bot
Copy link
Copy Markdown
Member

modrinth-bot commented Mar 21, 2026

@IMB11 IMB11 marked this pull request as ready for review March 21, 2026 21:24
@IMB11 IMB11 enabled auto-merge March 23, 2026 17:22
@IMB11 IMB11 removed the request for review from a team March 23, 2026 17:24
Copy link
Copy Markdown
Contributor

@tdgao tdgao left a comment

Choose a reason for hiding this comment

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

LGTM!

@IMB11 IMB11 added this pull request to the merge queue Mar 23, 2026
Merged via the queue into main with commit c09f7fd Mar 23, 2026
11 of 13 checks passed
@IMB11 IMB11 deleted the cal/changelog-improvements branch March 24, 2026 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev-ex Improvements to developer experience

Development

Successfully merging this pull request may close these issues.

3 participants