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

[Question]: Should we use commitizen to enforce conventional commits and automate versioning? #359

Open
MaxDall opened this issue Feb 16, 2024 · 0 comments
Labels
question Further information is requested

Comments

@MaxDall
Copy link
Collaborator

MaxDall commented Feb 16, 2024

Question

While searching for a tool to automate versioning., I stumbled over commitizen.

Commitizen itself does not automate versioning but, when used in combination with pre-commit, enforces commitment conventions and provides functionality to bump up the version according to pep440 or semver using cz bump.

cz bump would also keep track of changes in a changelog.md

This may be two questions in one:

  1. Do we want to enforce commitment conventions?
  2. Do we want to use commitizen?
  3. (Do we want to use version generation?)

Update: We could also omit the version bump of cz bump and only enforce commit conventions 1.0.0 and use release-please for automated release and version bump. Together with #358 the workflow would be.

  1. Work on the current master branch
  2. release-please opens a release PR which is automatically updated alongside the current master branch (keeps track of changes, bumps version according to semver, pushes into changelog.md)
  3. If the release is ready, merge the release PR
  4. release-please automatically creates a release with a description based on the release PR
  5. Add release workflow to automatically publish on PyPi #358 automatically publishes on testpypi -> test distribution -> publish to PyPi but awaits confirmation.
@MaxDall MaxDall added the question Further information is requested label Feb 16, 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

1 participant