gpush is a command line utility for standardising commit messages using Conventional Commits. It is designed to be used in conjunction with semantic-release to automate the release of your package based on commits that are made on a branch when a PR is merged.
gpush natively supports signing commits using GPG. To enable this, you will need to have GPG installed and configured on your machine. You can find instructions on how to do this here.
This package is available for installation via git. To install the latest version, run the following command:
pip3 install git+https://github.com/tjtharrison/gpush.git
When running gpush in a git directory, use gpush to replace your standard git commit && git push commands. gpush will ask a few questions to determine detail about your commit and generate a conventionally formatted git commit message.
To see additional options available, run gpush with the --help flag
gpush --help
To develop locally, uninstall any existing version of gpush before executing the pip3 installation in the local directory, use Makefile command to do this:
make dev
To run unit tests, execute the following command, you will need to have pytest installed and set environment variable GITHUB_TOKEN to a valid GitHub token that has permissions to create/delete and push to a repository within your account.
make test
The unit tests will create a test repository within your account for each unit test before testing functionality and deleting the repository.