Check if pyproject.toml version was bumped
Project description
Check Bump
About
Want to add version bump checks to your CI/CD pipeline? This packages makes it easy.
Simply execute check-bump
within a directory where your pyproject.toml
is located.
If there was a version bump, process will finish with exit code 0 - read stdout for the new version. Otherwise, process will finish with exit code 1.
Requirements
This package requires tomlkit
package.
Usage
Command
Simply execute check-bump
within a directory where your pyproject.toml
is located. Or provide a path using --path
argument.
user$ check-bump --help
usage: check-bump [-h] {toml,regex,touch} ...
Detect and retrieve version bump
options:
-h, --help show this help message and exit
Methods:
{toml,regex,touch} Different methods for parsing files
toml Parsing toml file
regex Regex file parsing
touch Touch file check
Github Actions
Inputs
method
Required Select which method to use for detecting version bumps.
path
Optional Relative path of versioning file. Example: 'python_src/pyproject.toml'
prefix
Optional Prefix to provide for version output. Example: 'v'
Outputs
bump
always Whether there was a bump or not. Values: 'true'
|'false'
version
optional Current (if bumped) version with prefix. If there was no version bump - no output is provided.
Example usage
- name: Check bump
id: vbump
uses: rgryta/Check-Bump@main
with:
method: 'toml'
prefix: 'v'
And then you can later reference like:
- name: Tag repository
if: steps.vbump.outputs.bump == 'true'
run: |
echo "I was bumped to version: ${{ steps.vbump.outputs.version }}"
Development
Installation
Install virtual environment and check_bump package in editable mode with dev dependencies.
python -m venv venv
source venv/bin/activate
pip install -e .[dev]
How to?
Automate as much as we can, see configuration in pyproject.toml
file to see what are the flags used.
staging format # Reformat the code
staging lint # Check for linting issues
staging test # Run unit tests and coverage report
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
Built Distribution
Hashes for check_bump-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5754f012ea26119c970c7f66a0e4a82f30cac564b4eeffb4590b18b29faca359 |
|
MD5 | f5199b66db6c7bfc6d90ef1a6041e1a5 |
|
BLAKE2b-256 | ed092d46283b4835887c312c9d7d5f66c4552826424d42e7ed9ed4b31e5381de |