Add git cliff config
#2662
Merged
Add git cliff config
#2662
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
I'm open to using a different tool for this, the main requirements are filtering based on github PR labels and matching the |
konstin
force-pushed
the
konsti/git-cliff
branch
from
6a7eebd to
6afaf4e
Compare
Member
Author
|
This works now, generating e.g.: ## [unreleased]
- Search_lib_dir: Only recurse into `build*` if it is a directory. ([#2734](https://github.com/pyo3/maturin/pull/2734))
- Add freebsd 14.2 amd64 sysconfig ([#2741](https://github.com/pyo3/maturin/pull/2741))
- Add `git cliff` config |
konstin
force-pushed
the
konsti/git-cliff
branch
from
6afaf4e to
b6b62e4
Compare
When I started maturin, I chose the https://keepachangelog.com style for the project changelog, and would edit the changelog manually. I now want to change this to automated changelog generation and a slightly improved style. This PR adds a [git cliff](https://git-cliff.org/) config that can generate the changelog based on commits and PR labels. The style is simplified, The version header doesn't have a link anymore, and the PR link is in parentheses behind the description. It also adds a release guide to the contributing guidelines, with the goal of simplifying the release workflow. Blocked on orhun/git-cliff#1189
konstin
force-pushed
the
konsti/git-cliff
branch
from
b6b62e4 to
7f05cc1
Compare
Member
Author
|
We can refine the config over time, but I want to try using this for the next release I make. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I started maturin, I chose the https://keepachangelog.com style for the project changelog, and would edit the changelog manually. I now want to change this to automated changelog generation and a slightly improved style.
This PR adds a git cliff config that can generate the changelog based on commits and PR labels. The style is simplified, The version header doesn't have a link anymore, and the PR link is in parentheses behind the description.
It also adds a release guide to the contributing guidelines, with the goal of simplifying the release workflow.
Blocked on orhun/git-cliff#1189