Skip to content
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.

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

Use conventional commits and commit linter? #1152

Closed
janfb opened this issue Apr 29, 2024 · 2 comments
Closed

Use conventional commits and commit linter? #1152

janfb opened this issue Apr 29, 2024 · 2 comments
Labels
question Further information is requested

Comments

@janfb
Copy link
Contributor

janfb commented Apr 29, 2024

For previous releases we crafted the CHANGELOG.md by hand. For the upcoming release this is a lot of work. So I looked into automated tools and came across:

A commit message convention and a linter that checks commit messages 🚓

I really like the idea, most importantly because it supports automatic generation of CHANGELOGs and semantic versioning.

image

any thoughts?

@janfb janfb added the question Further information is requested label Apr 29, 2024
@michaeldeistler
Copy link
Contributor

Depends on how well it works I guess :) If it just copies PR descriptions (or commit titles) then I think the resulting CHANGELOG will not really helpful, but if it has some LLM to filter relevant content then it might be great.

@janfb janfb added this to the Hackathon and release 2024 milestone Aug 6, 2024
@janfb janfb removed this from the Hackathon and release 0.23 milestone Aug 20, 2024
@janfb
Copy link
Contributor Author

janfb commented Aug 23, 2024

let's just try to follow this convention when we do squash commits for PRs onto main. This will make it easier to order the commits on main.

For the changelog it will just be a lot of work for the upcoming release, but otherwise I noticed that GitHub already offers creating a list of all commits since the last release when one creates the entry on GitHub.

@janfb janfb closed this as completed Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants