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:
  - "major:"
  - "breaking:"

minor:
  - "minor:"

patch:
  - "patch:"

Installation:

Run pip install cloudmitigator_semantic

This will install a script called semantic

Usage:

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.

v0.0.1

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

False

Requirements:

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


Release history Release notifications

Download files

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

Files for cloudmitigator-semantic, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size cloudmitigator_semantic-0.1.0-py3.8.egg (10.6 kB) File type Egg Python version 3.8 Upload date Hashes View hashes
Filename, size cloudmitigator_semantic-0.1.0-py3-none-any.whl (11.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size cloudmitigator_semantic-0.1.0.tar.gz (4.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page