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

Enforce commit conventions locally with commitizen #97

Closed
Tracked by #175
redeboer opened this issue Jan 22, 2023 · 1 comment
Closed
Tracked by #175

Enforce commit conventions locally with commitizen #97

redeboer opened this issue Jan 22, 2023 · 1 comment
Assignees
Labels
🖱️ DX Improvements to the Developer Experience

Comments

@redeboer
Copy link
Member

redeboer commented Jan 22, 2023

ComPWA's commit conventions can probably be enforced locally as well with commitizen. It can also be used as a pre-commit hook and it can be installed at the commit stage with the new default_install_hook_types.

default_install_hook_types:
  - commit-msg
  - pre-commit
  - pre-push

repos:
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v2.39.1
    hooks:
      - id: commitizen

It still needs to be found out how to configure the commit types. Probably best to configure commitizen through pyproject.toml.


Note that commit conventions are already enforced to PR titles with commitlint.config.js (see corresponding workflow here). It would be nice if this configuration redundancy can be removed somehow.

@redeboer redeboer added the 🖱️ DX Improvements to the Developer Experience label Jan 22, 2023
@redeboer redeboer self-assigned this Jan 22, 2023
@redeboer
Copy link
Member Author

redeboer commented Oct 5, 2023

Closing this for now, as it is incompatible with #177, because commitlint requires you to add a config in each repository...

@redeboer redeboer closed this as completed Oct 5, 2023
@redeboer redeboer reopened this Oct 5, 2023
@redeboer redeboer closed this as not planned Won't fix, can't repro, duplicate, stale Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖱️ DX Improvements to the Developer Experience
Projects
None yet
Development

No branches or pull requests

1 participant