Skip to content

Commit d9d38ca

Browse files
author
Dominik Falkner
committed
feat: Remove conventional commits
1 parent 7aef350 commit d9d38ca

3 files changed

Lines changed: 2 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ A simple [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template f
1919
- Ready to use **Docker images** as a base CI/CD
2020
- Cross-platform support for Linux, macOS (Apple silicon and Intel), and Windows
2121

22-
### Extras
23-
- Optionally follows the [Conventional Commits](https://www.conventionalcommits.org/) standard to automate [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/) with [Commitizen](https://github.com/commitizen-tools/commitizen)
24-
2522
### Planned
2623
- [ ] **Automatic dependency** updates with [RenovateBot]()
2724

@@ -30,7 +27,7 @@ A simple [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template f
3027
### Creating a new Python project
3128

3229
1. Install [Cruft](https://github.com/cruft/cruft) and [Cookiecutter](https://github.com/cookiecutter/cookiecutter)
33-
2. In the directory that contains the cloned repository, run:
30+
2. Run:
3431
```sh
3532
cruft create -f https://gitdma.risc-software.at/common/python-package-template
3633
```
@@ -48,7 +45,6 @@ A simple [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template f
4845
| `author_email` <br> "sonja.sunshine@risc-software.at" | The email address of the primary author of the package. |
4946
| `python_version` <br> "3.11" | The minimum Python version that the package requires. |
5047
| `docstring_style` <br> ["Google", "Numpy"] | Whether to use and validate [NumPy-style](https://numpydoc.readthedocs.io/en/latest/format.html) or [Google-style docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). |
51-
| `use_conventional_commits` <br> [true, false] | If true, [Commitizen](https://github.com/commitizen-tools/commitizen) will verify that your commits follow the [Conventional Commits](https://www.conventionalcommits.org/) standard. Then, `cz bump` may be used to automate [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/). |
5248

5349
## Supported Poe Tasks
5450

‎cookiecutter.json‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"author_email": "sonja.sunshine@risc-software.com",
77
"python_version": "3.11",
88
"docstring_style": ["Google", "Numpy"],
9-
"use_conventional_commits": true,
109
"__package_name_kebab_case": "{{ cookiecutter.package_name|slugify }}",
1110
"__package_name_snake_case": "{{ cookiecutter.package_name|slugify(separator='_') }}"
12-
}
11+
}

‎{{ cookiecutter.__package_name_kebab_case }}/pyproject.toml‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,6 @@ pytest-xdist = "^3.3.1"
3737
mkdocs = "^1.4.3"
3838
mkdocs-material = "^9.1.15"
3939
mkdocstrings = {extras = ["python"], version = "^0.22.0"}
40-
{%- if cookiecutter.use_conventional_commits %}
41-
commitizen = "^3.2.2"
42-
{%- endif %}
4340

4441
# https://github.com/nat-n/poethepoet
4542
[tool.poe.tasks]
@@ -85,13 +82,3 @@ max-doc-length = 120
8582

8683
[tool.ruff.pydocstyle]
8784
convention = "{{ cookiecutter.docstring_style|lower }}"
88-
89-
{%- if cookiecutter.use_conventional_commits %}
90-
# https://commitizen-tools.github.io/commitizen/config/
91-
[tool.commitizen]
92-
bump_message = "bump(release): v$current_version → v$new_version"
93-
tag_format = "v$version"
94-
update_changelog_on_bump = true
95-
version = "0.0.1"
96-
version_files = ["pyproject.toml:version"]
97-
{%- endif %}

0 commit comments

Comments
 (0)