Easily create releases in git
Project description
git-release
Easily generate tag-based releases. Uses the powerful git-cliff
to generate changelogs. These can then be leveraged via github actions
Installation
# Install dependencies
cargo install git-cliff
# Install git-release
pip install git-release
Usage
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
Contributing
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)
Built Distribution
Close
Hashes for git_release-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5824c68eed60f140998e9bb9dcc2f679c54bdd57c4dda6ac41e1452eafad13ad |
|
MD5 | 0f7b3fb93308a96d88910101dfa4677c |
|
BLAKE2b-256 | df2db219815e2cb382e35afc6c9dbf3fcbfef883a89d6db75be7e56cdc1258c4 |