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

gitmoji vs. conventional commits -- auto-generated changelog #121

Open
falexwolf opened this issue Nov 29, 2024 · 4 comments
Open

gitmoji vs. conventional commits -- auto-generated changelog #121

falexwolf opened this issue Nov 29, 2024 · 4 comments

Comments

@falexwolf
Copy link
Member

Re: this change of the title in the corresponding PR

image

At Lamin, we're auto-creating the changelog and bucketing changes by UX (🚸), bug fixes (πŸ›), new features (✨) using the gitmoji pre-commit hook (https://gitmoji.dev/).

The idea is to get a friendly changelog without much effort, e.g., here: https://docs.lamin.ai/changelog/2024#db-0-76-16

So, if we add an emoji to the PR title, this here will be easy to read & re-organize: https://github.com/laminlabs/lamin-docs/blob/main/docs/changelog/soon/laminr.md

Similar to this: https://github.com/laminlabs/lamin-docs/blob/main/docs/changelog/soon/lamindb.md

Does this make sense -- can we do this also for laminr @lazappi @rcannood ? I know that most people use conventional commit instead of gitmoji but fastapi etc. are also following this alternative approach.

@lazappi
Copy link
Collaborator

lazappi commented Nov 29, 2024

I would be happy to do that. We might have to play around with setting up pre-commit but after that it should be ok. Not sure what @rcannood thinks though.

Is adding them to PRs also automated or do you have to do that manually?

@falexwolf
Copy link
Member Author

We might have to play around with setting up pre-commit but after that it should be ok.

Some on our team don't use it for every commit. And I also think this is not sooooo helpful. So, I don't think it's a requirement. All our other repos have pre-commit anyway and now that I think of it gitmoji -i might even be independently hooking into git. πŸ€” So, you might not even need pre-commit.

Is adding them to PRs also automated or do you have to do that manually?

It depends on when you create the PR. If you create it after making the first commit on a new branch, the PR title will have the commit message as title.

But, to be honest, spending 1 min on making sure the PR title is well chosen and has an emoji that categorizes it well is well spent. I don't think automation is needed as it happens so rarely and should be done consciously.

@falexwolf falexwolf changed the title gitmoji vs. conventional commits gitmoji vs. conventional commits -- automated changelog Nov 29, 2024
@falexwolf falexwolf changed the title gitmoji vs. conventional commits -- automated changelog gitmoji vs. conventional commits -- auto-generated changelog Nov 29, 2024
@rcannood
Copy link
Collaborator

rcannood commented Dec 1, 2024

I see -- sure thing! We can switch to using this approach from the next release onwards :)

@falexwolf
Copy link
Member Author

Cool! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants