8000 GitHub - Tranquility2/semvergit: Manage your project's version numbers
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Tranquility2/semvergit

BranchesTags

Repository files navigation
CI/CD Pytest Publish GitHub Latest Release) Coverage Status pre-commit
Package PyPI - Version PyPI - Python Version Downloads
Meta Code style: black security: bandit Imports: isort linting: pylint Checked with mypy License - MIT

semvergit

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

  1. Use the latest git tag to determine the current version number.
  2. Bump the version number
  3. Create a new git tag
  4. 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.

< 8162 div class="markdown-heading" dir="auto">

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 see the limitations section below

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:

  1. create the relvant tag (in this case a patch bump 0.0.x -> 0.0.x+1)
  2. 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.

Limitations

Please keep in mind that when using features like commit message / auto commit message and version file the tool will try and commit the changes to the git repo.

Even though this is quite handy, it should be used mannually as it cannot be used directly in a CI/CD pipeline directed at master or main branches as it will likly fail due to the commit not being allowed without a PR.

💡 Only git tags can be pushed to the remote without a PR (and this is the main use case for this tool).

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.

About

Manage your project's version numbers

Topics

git cli semver versioning

Resources

Readme

License

MIT license
Activity

Stars

3 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases 11

v0.4.2 Latest
Apr 22, 2024
+ 10 releases

Contributors 2

  •  
  •  

Languages

0