Skip to content

fix: release-please changelog #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Akaseli merged 1 commit into from
Jul 2, 2026
Merged

fix: release-please changelog #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
13 changes: 13 additions & 0 deletions release-please-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading