Semversioner
The easiest way to manage semantic versioning in your project and generate CHANGELOG.md file automatically.
Semversioner will provide the tooling to automate semver release process for libraries, docker images, etc.
This project was inspired by the way AWS manages their versioning for AWS-cli.
Semantic Versioning
The semantic versioning spec involves several possible variations, but to simplify, in Semversioner we are using the three-part version number:
<major>.<minor>.<patch>
Constructed with the following guidelines:
- Breaking backward compatibility or major features bumps the major (and resets the minor and patch).
- New additions without breaking backward compatibility bumps the minor (and resets the patch).
- Bug fixes and misc changes bumps the patch.
An example would be 1.0.0
How it works
At any given time, the .semversioner/ directory looks like:
.semversioner
└── next-release
├── minor-20181227010225.json
└── major-20181228010225.json
├── 1.1.0.json
├── 1.1.1.json
├── 1.1.2.json
The release process takes everything in next-release and aggregates them all together in a single JSON file for that release (e.g 1.12.0.json). This
JSON file is a list of all the individual JSON files from next-release.
Install
$ pip install semversioner
Usage
Bumping the version
In your local environment your will use the CLI to create the different changeset files that will be committed with your code. For example:
$ semversioner add-change --type patch --description "Fix security vulnerability with authentication."
Then, in your CI/CD tool you will need to release (generating automatically version number) and creating the the changelog file.
$ semversioner release
Generating Changelog
As a part of your CI/CD workflow, you will be able to generate the changelog file with all changes.
$ semversioner changelog > CHANGELOG.md
You can customize the changelog by creating a template and passing it as parameter to the command. For example:
$ semversioner changelog --template .semversioner/config/template.j2
The template is using Jinja2, a templating language for Python. For example:
# Changelog
{% for release in releases %}
## {{ release.version }}
{% for change in release.changes %}
- {{ change.type }}: {{ change.description }}
{% endfor %}
{% endfor %}
You can filter the changelog by only showing changes for a specific version:
$ semversioner changelog --version "1.0.0"
Alternatively, you can use the following command to filter changes by the last released version:
$ semversioner changelog --version $(semversioner current-version)
License
Copyright (c) 2021 Raul Gomis. MIT licensed, see LICENSE file.
Made with ♥ by Raul Gomis <https://twitter.com/rgomis>.
Changelog
Note: version releases in the 0.x.y range may introduce breaking changes.
1.0.0
- major: Drop support for Python 3.6.
- minor: Add type hinting.
- minor: Bump click dependency to 8.0.3.
- minor: Bump jinja2 dependency to 3.0.3.
- patch: Add Python 3.10 testing in the CI/CD process.
- patch: Bump importlib_resources dependency to 5.4.0.
- patch: Bump pytest dependency to 6.2.5.
- patch: Bump twine dependency to 3.7.1.
- patch: Bump wheel dependency to 0.37.0.
- patch: Remove unnecessary dependency: colorama.
- patch: Rename semversioner directory to .semversioner.
0.13.0
- minor: Add support for custom changelog template
- patch: Fix security vulnerability with jinja2 CVE-2020-28493
0.12.0
- minor: Improved performance by supporting multiple changeset files per second
- minor: Status command now sorts unreleased changes by type and description in order to display consistent results
- patch: Internal code refactor to improve code readability and maintanability
0.11.0
- minor: Add '--version' filter to the 'changelog' command to display the changelog only for a specific version
0.10.0
- minor: Add new 'status' command to display the state of the working directory and unreleased changes
- patch: Fix build and deployment configuration
- patch: Refactor method names and code for better code readability and testability
0.9.0
- minor: Deprecated .changes directory in favour of .semversioner directory
- patch: Internal refactor to improve code quality and test coverage
0.8.1
- patch: Fix installer error when referencing to LICENSE file
0.8.0
- minor: Enabled autocompletion by default
0.7.1
- patch: Improve docs for open source
0.7.0
- minor: Fail with error code when no changes are provided in the release command
0.6.16
- patch: Fix bug: add require module in setup.py
0.6.15
- patch: Fix packaging for LICENSE
- patch: Improve README.md documentation
- patch: Use jinja2 template engine internally to generate the changelog
0.6.14
- patch: Update docs
0.6.13
- patch: Fix README.md
0.6.12
- patch: Fix long description content type
0.6.11
- patch: Add README.md file
0.6.10
- patch: Fix code consistency
0.6.9
- patch: Fix packaging
0.6.8
- patch: Tag the repository when releasing
0.6.7
- patch: Fix tests and improve coverage
0.6.6
- minor: Initial version
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file semversioner-1.0.0.tar.gz.
File metadata
- Download URL: semversioner-1.0.0.tar.gz
- Upload date:
- Size: 9.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.7.1 importlib_metadata/4.2.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1771d0386f872b25732f50ee33354a9d95c273f04a99cd486d816c490a22cf0f
|
|
| MD5 |
43ec3efa1500dff2f2b666e12ff6a695
|
|
| BLAKE2b-256 |
4813114531e28c4bab66a8590dc6e18f9622516c73c7229cef030cc305dd9c67
|
File details
Details for the file semversioner-1.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: semversioner-1.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/3.7.1 importlib_metadata/4.2.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fef0864a67cf156c19bd1d6c35e2afa0b3389100b3938836499f0ac2e37e4a7c
|
|
| MD5 |
9bb0247222bbd760e63f15232bb979b8
|
|
| BLAKE2b-256 |
50b2880f0d751e9f2f2f4a338771ec752596e4e3ad4cac8244530a752c18c5b4
|
