From 42fb9cc60ffba73723698aa941a0230667abd812 Mon Sep 17 00:00:00 2001 From: Akseli Lehtniemi <60463103+Akaseli@users.noreply.github.com> Date: Thu, 2 Jul 2026 14:33:30 +0300 Subject: [PATCH] fix: release-please changelog --- README.rst | 4 ++-- release-please-config.json | 13 +++++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c88308e..9ad95da 100644 --- a/README.rst +++ b/README.rst @@ -232,8 +232,8 @@ SemVer ``MAJOR.MINOR.PATCH`` from Conventional Commit messages (``fix:`` bumps p minor, ``feat!:`` / ``BREAKING CHANGE:`` bumps major) and opens a release PR. Merging it tags the release, publishes the Docker image, and attaches the OpenAPI spec (``openapi.json``) to the GitHub release. -Only ``feat``, ``fix``, ``perf``, ``deps``, ``revert`` and ``docs`` land in the changelog; everything else is -hidden. This is currently the release-please default split and can be reconfigured later. +Every Conventional Commit lands in the changelog: ``feat``, ``fix`` and ``revert`` get their own +sections, everything else (``perf``, ``chore``, ``docs``, ``ci``, ...) is grouped under *Other Changes*. Merge PRs with **"Rebase and merge"**, never squash: this preserves the individual commits in git history and lets release-please parse every Conventional Commit. diff --git a/release-please-config.json b/release-please-config.json index b26cb1a..74738df 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -6,6 +6,19 @@ "package-name": "matrixrmapi", "include-component-in-tag": false, "changelog-path": "CHANGELOG.md", + "changelog-sections": [ + { "type": "feat", "section": "Features" }, + { "type": "fix", "section": "Bug Fixes" }, + { "type": "revert", "section": "Reverts" }, + { "type": "perf", "section": "Other Changes" }, + { "type": "chore", "section": "Other Changes" }, + { "type": "docs", "section": "Other Changes" }, + { "type": "style", "section": "Other Changes" }, + { "type": "refactor", "section": "Other Changes" }, + { "type": "test", "section": "Other Changes" }, + { "type": "build", "section": "Other Changes" }, + { "type": "ci", "section": "Other Changes" } + ], "extra-files": [ "src/matrixrmapi/__init__.py", "tests/test_matrixrmapi.py",