Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

devex: changelog system#5309

Open
IMB11 wants to merge 7 commits intomain from
cal/changelog-improvements
Open

devex: changelog system #5309
IMB11 wants to merge 7 commits intomain from
cal/changelog-improvements

Conversation

@IMB11
Copy link
Member

@IMB11 IMB11 commented Feb 6, 2026

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

  • Introduces a fragment-based changelog system using YAML files in .github/changelog/, with scripts to create and bake them into packages/blog/changelog.ts
  • Moves changelog data from @modrinth/utils to @modrinth/blog
  • Adds CI workflow to remind PR authors to include a changelog fragment, with automatic comment cleanup when one is added - it's always going to be optional though.
  • Adds automatic GitHub release creation with changelog body to the Modrinth App release workflow - will document this in Notion.
  • new-changelog script now supports creating multiple entries in a single run, with content-hashed filenames

Workflow changes include:

  • pnpm scripts new-changelog — interactive prompt to create changelog fragments
  • pnpm scripts bake-changelog -- --product <name> [--version X.Y.Z] — consumes fragments and inserts entries into changelog.ts
  • pnpm scripts bake-changelog -- --product app --version X.Y.Z --extract — outputs the baked body for a version (used by CI)
  • pnpm scripts bake-changelog -- --product web is the same as running it for both hosting + platform.

CI changes:

  • changelog-check.yml — on PRs, posts a bot comment if no changelog fragment is present; minimizes it as outdated once one is added
  • theseus-release.yml — now extracts the app changelog and creates a GitHub release with it

Also did some small improvements to the changelog.vue page

@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
Copy link
Member

modrinth-bot commented Feb 6, 2026
edited
Loading

Note

No changelog fragment was found for this pull request. If this PR includes user-facing changes, run pnpm scripts new-changelog to create one.

@IMB11 IMB11 marked this pull request as draft February 6, 2026 13:45
Copy link
Contributor

github-actions bot commented Feb 6, 2026
edited
Loading

@IMB11 IMB11 marked this pull request as ready for review February 6, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dev-ex Improvements to developer experience

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /