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

[RFC] Move to conventional commit and conventional changelog #104

Closed
JellyBellyDev opened this issue Jan 8, 2024 · 4 comments · Fixed by #106
Closed

[RFC] Move to conventional commit and conventional changelog #104

JellyBellyDev opened this issue Jan 8, 2024 · 4 comments · Fixed by #106

Comments

@JellyBellyDev
Copy link
Collaborator

Hi @garak @AlessandroMinoccheri @antonkomarev

WDYT about to move in a conventional commit and conventional changelog way?

If we do this we could automate the process of generating a new release and updating the changelog file automatically.

I tried this flow in my personal repo with an github action: https://github.com/JellyBellyDev/ImageOrientationFix/blob/master/.github/workflows/release.yml

How it works: when we would generate a new release go to tab actions, select "Create release" workflow, and click on "Run workflow".
The workflow will do:

  • choose new bump version (from conventional commits)
  • update the file changelog
  • commit file changelog updated
  • push new tag and release tag

Ref:

Example:
See the last two release:
https://github.com/JellyBellyDev/ImageOrientationFix/releases
https://github.com/JellyBellyDev/ImageOrientationFix/blob/master/CHANGELOG.md

WDYT?

@garak
Copy link
Collaborator

garak commented Jan 8, 2024

It looks good to me, but then we should validate the commit messages. In your personal repo it's easy since you're the only committer, but it's not the same here.

@JellyBellyDev
Copy link
Collaborator Author

Exactly!
If you liked the idea, my second question would have been about validating commit messages.
Which tool would you prefer?
Would you prefer to add a tool on the githook side or a control on the CI side?

@garak
Copy link
Collaborator

garak commented Jan 8, 2024

A GitHub action would be better for me

@JellyBellyDev
Copy link
Collaborator Author

WDYT?
#105

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

Successfully merging a pull request may close this issue.

2 participants