Skip to main content

Means of automating the release version of a git repo using git tags

Project description

CloudMitigator Semantic

Test and Release Version PyPI version

Allows you to manage versioning and releases using git tags as the source of truth. No more manual bumping of version files. CloudMitigator Semantic allows the user to control releases via commit messages. All the rest is handled for you. Just use trigger words listed below, and if a word is detected, a release will be automatically completed. Incrementing the specified number.

  • Major release: Major: major:
  • Minor release: Minor: minor:
  • Patch release: Patch: patch:

Trigger words can also be modified through the inclusion of a semantic.yml.

  - "major:"
  - "breaking:"

  - "minor:"

  - "patch:"


Run pip install cloudmitigator_semantic

This will install a script called semantic


Run semantic --help for a list of commands that can be run.

semantic version will return the latest git tag version if it has been changed, or the current git tag version if unchanged.


semantic changed will return a boolean on whether or not the version has been incremented.



Must run command within a directory that has git initialized.

If no version tag is specified then a default of v0.0.0 will be given. Make sure to tag your repo if you wish to start at a different seed number.

This module is only compatible with 'v' tagging. This means '0.0.0' will not be recognized where 'v0.0.1' will be.

This is meant to be run as part of a github action. Please see the sample implementation for an example.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cloudmitigator_semantic-0.1.6.tar.gz (4.8 kB view hashes)

Uploaded Source

Built Distributions

cloudmitigator_semantic-0.1.6-py3.8.egg (11.5 kB view hashes)

Uploaded Source

cloudmitigator_semantic-0.1.6-py3-none-any.whl (11.7 kB view hashes)

Uploaded Python 3

Supported by

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