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 .changes/ directory looks like:
.changes
└── 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
Contributing
See CONTRIBUTING.md.
License
Copyright (c) 2019 Atlassian and others. Apache 2.0 licensed, see LICENSE.txt file.
Made with ♥ by Raul Gomis <https://twitter.com/rgomis>.
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
File details
Details for the file semversioner-0.8.0.tar.gz.
File metadata
- Download URL: semversioner-0.8.0.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
303a195c65c27fa5c183bdd39309dd7bd8df8449b14f1d038ee44e89e68e2651
|
|
| MD5 |
2813d6a4cd4970506f8dd06f5eea0e46
|
|
| BLAKE2b-256 |
3c7c4701ced67658872f0e97c879203f9db5c21f6fb3f4c1de61577ce89bc6a8
|
