Skip to main content

Python version bumper

Project description

Build Code Coverage Version License Python Version

A simple Python script for updating the version in Kubernetes Helm Chart.yaml, VERSION, and pyproject.toml/setup.py files.

  • Ensures version consistency across all files.

  • Enforces Semantic Versioning 2.0.0.

  • Supports an optional lowercase ‘v’ prefix (e.g., v1.5.4-beta2).

./docs/pybump-recording.gif

Installation

To install pybump, run:

pip install pybump

Usage

Bumping Versions

To bump the version:

pybump bump [-h] --file PATH_TO_CHART.YAML --level {major,minor,patch} [--quiet]

Setting Explicit Versions

To set an explicit version or automatically update release metadata:

pybump set --file PATH_TO_CHART.YAML --set-version X.Y.Z [--quiet]

The auto flag is primarily intended for CI/CD pipelines, such as pull request workflows:

pybump set --file PATH_TO_CHART.YAML --auto [--quiet]

When using –auto, pybump appends the Git commit hash as release metadata to the version.

  • Warning - The –auto flag can be risky, as it may detect a Git repository unintentionally. Ensure that the target file is part of the correct repository before running this command.

Retrieving the Current Version

To get the current version:

pybump get --file PATH_TO_CHART.YAML

Updating Helm Chart appVersion

To bump, get, or set the appVersion field in a Helm chart, use the --app-version flag:

pybump bump [-h] --file PATH_TO_CHART.YAML --level {major,minor,patch} [--quiet] [--app-version]

Examples

CI Usage example

A simple Jenkins CI pipeline (using the Kubernetes plugin) that utilizes the set --file setup.py --auto option:

String label = "test-bump-ci-runner"
podTemplate(
        label: label,
        containers: [
                containerTemplate(
                        name: 'pybump',
                        image: "arielev/pybump:1.10.2",
                        ttyEnabled: true,
                        command: 'sleep',
                        args: '1d'
                ),
                containerTemplate(
                        name: 'jnlp',
                        image: 'jenkins/inbound-agent:jdk11',
                        ttyEnabled: true
                )
        ]
) {
    node(label) {
        timeout(time: 10, unit: 'MINUTES') {
            ansiColor('xterm') {
                String version = ""
                container('jnlp') {
                    git credentialsId: "credentials_id_here", url: "https://github.com/arielevs/pybump"
                }
                container('pybump') {
                    version = sh(
                            script: "pybump set --file setup.py --auto",
                            returnStdout: true
                    ).trim()
                }
                println(version)
            }
        }
    }
}

Version Bumping Examples

Case: version: 0.0.1

pybump bump --file Chart.yaml --level patch

Result: Version updated to 0.0.2.

Case: version: 0.1.4-alpha+meta.data

pybump bump --file Chart.yaml --level minor

Result: Version updated to 0.2.0-alpha+meta.data.

Case: version: v0.0.3

pybump bump --file Chart.yaml --level major

Result: Version updated to v1.0.0.

Case: version: 0.0.1+some-metadata

pybump set --file Chart.yaml --set-version 1.4.0

Result: Version updated to 1.4.0+metadata-here.

Case: version: v7.0.2

pybump set --file setup.py --auto

Result: Version updated to v7.0.2-5a51e0e1d9894d3c5d4201619f10be242320cb59.

Case: appVersion: 2.3.2

pybump bump --file Chart.yaml --level patch --app-version

Result: appVersion updated to 2.3.3.

Case: version: 1.0.13

pybump get --file Chart.yaml

Result: Returns 1.0.13.

Case: version: 1.0.13+some-metadata

pybump get --file Chart.yaml --release

Result: Returns some.

Using a Container Image

To run pybump within a container:

docker run --rm --volume $(pwd):/tmp -t arielev/pybump set --file /tmp/setup.py --auto

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

pybump-1.13.2.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

pybump-1.13.2-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file pybump-1.13.2.tar.gz.

File metadata

  • Download URL: pybump-1.13.2.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.10

File hashes

Hashes for pybump-1.13.2.tar.gz
Algorithm Hash digest
SHA256 3d5313b367e5539e548e10a5c20bcc3dc9f20728ffb3e10e7508738861552a14
MD5 d2d39ab8dc2b962fa930846cc3c61ebc
BLAKE2b-256 2ed1bbd315af2c59aae3b43f4d8dbee72aed87023f243d4a39c0dfd018cd0485

See more details on using hashes here.

File details

Details for the file pybump-1.13.2-py3-none-any.whl.

File metadata

  • Download URL: pybump-1.13.2-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.10

File hashes

Hashes for pybump-1.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 027d65ac01d955a4c421134e6f990bda0207689eeb646932b9650a58dbd0b51b
MD5 479858c515bafb5a81bf6d7292c03e55
BLAKE2b-256 b979ec3f663c6f7a8355ddeb4887f30ea54bcab624011801aa246a131dcac2e0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page