diff --git a/README.md b/README.md index 7adfaa9..ba9c7f8 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,22 @@ Features: You may use it as a Python package or a Docker container. -## PIP Package +## Usage as PIP Package (python is required) +### Check commit message + +```shell +$ pygitver --check-commit-message "feat: conventional commmit example" +$ echo $? +0 +$ pygitver --check-commit-message "non-conventional commmit example" +ERROR: Commit does not fit Conventional Commits requirements +More about Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/ +$ echo $? +1 +``` + +### Get current/next version ```shell $ git tag -l v0.0.1 @@ -19,11 +33,62 @@ $ pygitver --curr-ver v0.0.2 $ pygitver --next-ver v0.0.3 - ``` +### Generate changelog +```shell +$ pygitver changelog +########## +Change Log +########## + +Version v0.0.3 +============= + +Features +-------- + +* Allow to trigger job manually + +Bug Fixes +--------- + +* Path for the default changelog template + +* Readme.md usage + +Improved Documentation +---------------------- + +* Add examples to the readme.md + +$ pygitver changelog --format json | jq . +{ + "version": "v0.0.3", + "bump_rules": { + "major": false, + "minor": false, + "patch": true + }, + "changelog": { + "features": [ + "allow to trigger job manually" + ], + "bugfixes": [ + "path for the default changelog template", + "README.md usage" + ], + "deprecations": [], + "others": [], + "docs": [ + "Add examples to the README.md" + ], + "non_conventional_commit": [] + } +} +``` -## Docker Container +## Usage as Docker container (docker engine is required) ```shell $ git tag -l @@ -146,7 +211,7 @@ feat(lang): add Polish language ## Users (Developers) Section -### Install pygitver +### Install Conventional Commit Git Hook Checker Run in the `git` root folder of the target repository on localhost. ```shell docker run --rm -v $(pwd):/app -w /app --user "$(id -u):$(id -g)" --entrypoint '' panpuchkov/pygitver /pygitver/scripts/install.sh