No project description provided
Project description
git-report
PyPI | |
---|---|
Quality | |
Format | |
Legal |
💢🔍 breaking change detection in Python - Compatible with Semantic Version and Semantic Release
Usage
Use the --help flag for detailed options:
git-report --help
git-report can be used in different ways, the most straightforward one is:
git-report --paths "tests" --target-version "<to-be-release-version>" --test-command "pytest tests"
The test-command
could be any command and does not need to be Python specific
Combine with scripts
It is also possible to simplify the test-command
by always using something like pipenv scripts
or npm scripts
So in the project.json
/ Pipfile
, one could define the test command and use git-report with npm run test
or pipenv run test
instead:
git-report --paths "tests" --target-version "<to-be-release-version>" --test-command "pipenv run test"
git-report --paths "tests" --target-version "<to-be-release-version>" --test-command "npm run test"
Semantic Release
If using the Python-Semantic-Release module, installable with:
pipx install python-semantic-release
One can integrate it with git-report by using:
git-report -t "$(semantic-release -v version --print)"
Installation
With Pipx
Recommended instalation for CICD is through pipx
with a pinned version:
pip install pipx==1.2.0
pipx run git-report==0.18.0 --paths "tests" --target-version "<to-be-release-version>" --test-command "pytest tests"
That command will create a virtual environment just for git-report and run the test command from there.
With pip
Instalation can be done with pip as usual:
pip install git-report
Pipenv and poetry equivalents can be used as well.
F.A.Q.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for git_stats_report-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 445a2832031bf223ea7e4326edff16c724e445a5d2d9a96f7eaeb3e418a874f6 |
|
MD5 | 3cffe58cc6b78131e61d9a376d16e1ee |
|
BLAKE2b-256 | 8070d1b557d3b87ec3ed60a9b8ac60ebc0112ae741af9b72e883c9d63b6113aa |