Skip to main content

Easily create releases in git

Project description

git-release status CI License OS: Linux PyPI - Downloads PyPI codecov

Easily generate tag-based releases. Uses the powerful git-cliff to generate changelogs. These can then be leveraged via github actions


# Install dependencies
cargo install git-cliff

# Install git-release
pip install git-release


usage: git-release [-h] [--comment COMMENT] [--remote REMOTE] [-v] [--semver SEMVER] [--major | --minor | --patch | --no-inc]

optional arguments:
  -h, --help            show this help message and exit
  --comment COMMENT, -c COMMENT
                        A comment to describe the release. Synonymous to a tag message. Defaults to the generated changelog.
  --remote REMOTE, -r REMOTE
                        The repository remote (defaults to 'origin')
  -v, --verbose         NOT IMPLEMENTED YET

Semantic Version:
  Options to manipulate the version. If --semver is not passed, git-release uses the most recent tag.

  --semver SEMVER       Custom semantic version. Use --no-inc to use as is.
  --major, -M           Increment the major version by 1 (resets minor and patch)
  --minor, -m           Increment the minor version by 1 (resets patch)
  --patch, -P           Increment the patch version by 1 (default behaviour)
  --no-inc              Don't increment anything


Ensure that pre-commit is installed and working. Otherwise the pre-commit CI will most likely fail.

# Install and setup pre-commit
pip install pre-commit
pre-commit install --install-hooks

Repos that have used git-release

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

git-release-0.2.1.tar.gz (25.8 kB view hashes)

Uploaded source

Built Distribution

git_release-0.2.1-py3-none-any.whl (18.5 kB view hashes)

Uploaded py3

Supported by

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