Convbump
convbump is a simple tool to work with conventional commits.
Use the version command to find the next version in your repository
based on the conventional commits.
Use the changelog command to generate a nicely formatted changelog
(Github markdown compatible).
Use convbump --verbose version to see more information.
Requirements
convbump does not have any external dependencies.
convbump uses a pure Python library to access the Git repository and so does not
require a git executable.
Development
The application is written in Python and uses Poetry to configure the package and manage its dependencies.
Make sure you have Poetry CLI installed. Then you can run
$ poetry install
which will install the project dependencies (including dev dependencies) into a
Python virtual environment managed by Poetry (alternatively, you can activate
your own virtual environment beforehand and Poetry will use that).
Run tests with pytest
$ poetry run pytest
or
$ poetry shell
$ pytest
pytest will take configuration from pytest.ini file first (if present), then
from pyproject.toml. Add any local configuration to pytest.ini.
Configuration in pyproject.toml will be used in CI. You can run your
tests the same way as CI to catch any errors
$ pytest -c pyproject.toml
Code formatting
The application is formatted using black and isort.
You can either run black and isort manually or use prepared Poe task to format the whole project.
$ poetry run poe format-code
or
$ poetry shell
$ poe format-code
Release files for convbump 2.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| convbump-2.1.1.tar.gz | 10.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| convbump-2.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 22.3 kB
Release files / convbump-2.1.1.tar.gz
| Download URL | convbump-2.1.1.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f5ac6c4eaff71846722fa73081ec55ef900127d921f1e36dd8773cf0adbdd10
|
|
BLAKE2b-256 checksum How to use checksums |
0664f75fbab135563bcdd1eade983ba5755f260b5837abd8ef0c5502c768555a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.12.14 Linux/6.17.0-1022-azure
|
Release files / convbump-2.1.1-py3-none-any.whl
| Download URL | convbump-2.1.1-py3-none-any.whl |
|---|---|
| Size | 11.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e76462d29535d9d1e3fdf58e389e7cda6b06ac6210401224ef595585c61d88e3
|
|
BLAKE2b-256 checksum How to use checksums |
c433d301e5b7bcf85091fd939797bf07300c405f6e22434350fcaac43c72d4ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.12.14 Linux/6.17.0-1022-azure
|
