Automatic semantic versioning for python projects
Project description
Automatic semantic versioning for python projects. This is an python implementation of the semantic-release for js by Stephan Bönnemann. If you find this topic interesting you should check out his talk from JSConf Budapest.
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. --post If used with the changelog command, the changelog will be posted to the release api. --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.
changelog - Generates the changelog for the next release.
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 would semantic-release <command>.
try:
from semantic_release import setup_hook
setup_hook(sys.argv)
except ImportError:
pass
Configuration
Configuration belongs in semantic_release section of the setup.cfg file in your project. Details about configuration options can be found in the configuration documentation.
Found a bug
Please create a pull-request with a test case that shows the usage. If you are unsure were to put it, just create a new file inside tests, and we will point you in the right direction.
Have a feature request
Check the trello board and roadmap.md to see if it is already in the pipeline. If not make a pull-request to roadmap.md.
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-3.10.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e95176679cc54eeda855d6d91a9796fb9d94a1c3f254069cd926df804ee7049 |
|
MD5 | dce2818762b1b365605bccfd758872cf |
|
BLAKE2b-256 | 86d484f260af9f85e5134470a78b4c00df921a624f067524143da91cc41a923c |