Skip to main content

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.

Build status PyPI version

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.
  --retry  Retry the same release, do not bump.
  --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.

Development

Install this module and the development dependencies:

python setup.py develop
pip install -r requirements/dev.txt

Testing

To test your modifications locally:

tox

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 Distribution

python-semantic-release-4.3.4.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

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

python_semantic_release-4.3.4-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file python-semantic-release-4.3.4.tar.gz.

File metadata

  • Download URL: python-semantic-release-4.3.4.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5

File hashes

Hashes for python-semantic-release-4.3.4.tar.gz
Algorithm Hash digest
SHA256 96b8138c287e84f3c46f41f03fe08c6f59f67e67c82894c94f2aa3a2e0e5d930
MD5 3a16e6a15fbf7f414b3a3c7f3119f838
BLAKE2b-256 125cef284b289548cbfefbddebb9b859be262c2ecf27d42caebb6f68c16249da

See more details on using hashes here.

File details

Details for the file python_semantic_release-4.3.4-py3-none-any.whl.

File metadata

  • Download URL: python_semantic_release-4.3.4-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.7.5

File hashes

Hashes for python_semantic_release-4.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9a1d32f7a5a507c3f09c0935da5d20e07b93cad47ede6a725098bd0fd58b51c7
MD5 b147ad424628bd3dd9702804e5f05f48
BLAKE2b-256 1250c2ea115bfe8155054246c86423cb541ea40837550566ca97b9314d5a6f2f

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