Skip to main content

Automatic semantic versioning for python projects

Project description

semantic-release Join the chat at https://gitter.im/relekang/python-semantic-release PyPI version

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

Configuration belong in semantic_release section of the setup.cfg file in your project. Details about configuration options can be found in the configuration documentation.

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

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_semantic_release-2.1.1-py2.py3-none-any.whl (21.1 kB view details)

Uploaded Python 2Python 3

File details

Details for the file python_semantic_release-2.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_semantic_release-2.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d98b9ff6064ab17b9bd6154c73263a85bb515ae6cffa95ac7917c58fd93dfe3d
MD5 f91c95885195187eeab1807339d28d3c
BLAKE2b-256 2248c4e83131e3de4900449b9c4d69a0ee47a6b0249be2ae3364925551415217

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page