Manage your project's version numbers.
Project description
CI/CD | |
Package | |
Meta | |
semvergit
semvergit is a CLI tool to manage your project's version numbers. It uses Semantic Versioning to bump the version number. The supported bump types are:
major
minor
patch
prerelease
Internal Workflow
What's actully happening when you run this tool
- Use the latest git tag to determine the current version number.
- Bump the version number
- Create a new git tag
- Push the tag to the remote
Why?
I created this tool to help me manage my project's version numbers. I wanted a simple tool that I could use in my CI/CD pipeline to bump the version number and tag the commit.
Features
❇️ Bump the version number and update the git tag in one command ❇️ Dry run mode ❇️ Verbose mode ❇️ Custom commit message ❇️ Auto commit message 🆕 Version 0.4+ introduces the ability to automatically update the version number in a file
Please keep in mind it is designed to be used in a CI/CD pipeline (but not limited to...)
How to use
Simple install using
pip install semvergit
Then you can use it in your project as simply as:
semvergit -t patch -v
(to bump the patch version)
This will:
- create the relvant tag (in this case a patch bump 0.0.x -> 0.0.x+1)
- push it to the remote
Please checkout semvergit --help
for more info.
Usage: semvergit [OPTIONS] COMMAND [ARGS]...
CLI for semvergit.
Options:
--version Show the version and exit.
-d, --dry_run Dry run
-v, --verbose Verbose level [0<=x<=2]
-t, --bump_type TEXT Bump Type ['major', 'minor', 'patch', 'prerelease']
-m, --message TEXT Commit message
-am, --auto_message Auto commit message
-f, --version_file FILE Version file
--help Show this message and exit.
Development
Please see CONTRIBUTING.md
License
This project is published under the MIT license.
If you do find it useful, please consider contributing your changes back upstream.
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
Built Distribution
Hashes for semvergit-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b65a204e411d6b0bcf9294b96409fb3f22ae58363a6a1612f38865bb74cb96e5 |
|
MD5 | 86485e680a9e0ce2bd2a17fc6ec1631d |
|
BLAKE2b-256 | c0da60420713239f0dd300ef5f0b7b5778606d567b0e5fd304ef1926b559ed84 |