Automatic semantic versioning for python projects
Project description
Automatic semantic versioning for python projects. This blogpost explains in more detail.
Install
pip install python-semantic-release
Usage
The general idea is to have some sort of tag in commit messages that indicates certain types of changes. If a commit message lack a tag it is ignored. Running release can be run locally or from a CI service.
Usage: semantic-release [OPTIONS] COMMAND Options: --major Force major version. --minor Force minor version. --patch Force patch version. --noop No-operations mode, finds the new version number without changing it. --help Show this message and exit.
Commands
version - Create a new release. Will change the version, commit it and tag it.
publish - Runs version before pushing to git and uploading to pypi.
Running commands from setup.py
Add the following to your setup.py and you will be able to run python setup.py <command> as you woul semantic-release <command>.
try:
from semantic_release import setup_hook
setup_hook(sys.argv)
except ImportError:
pass
Configuration
All configuration described here belongs in setup.cfg in a section: semantic-release.
version_variable - The filename and variable name of where the version number is stored, e.g. semantic_release/__init__.py:__version__. patch_without_tag - If set to true semantic-release will create a new release even if there is no tag in any commits since last release. Default: false. check_build_status - If set to true the status of the head commit will be checked and a release will only be created if the status is success. Default: false.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for python_semantic_release-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 012657c5d9d28dbe667abfb6b9665884aa7430df71d5032aae65a12065b0f22b |
|
MD5 | 10a2dfcab7352c16f746317ab79b3c61 |
|
BLAKE2b-256 | 905b9809a8853f244f0213b0864cc109699581a63dca0ffa5fc69542d64c0d72 |