Skip to main content

jrl_release.py

Version management script for multi-format projects. Keeps version strings in sync across all tracked files and automates the release process.

Usage

The tool can be invoked two equivalent ways:

# Installed console command — after `pip install .` / `uv tool install .`, or inside `uv run`
jrl-release [OPTIONS]

# Standalone, no install — runs the script directly via uv (PEP 723 inline deps)
uv run --no-project jrl_release.py [OPTIONS]

The standalone form requires uv; it auto-installs dependencies from the script's inline metadata.

The examples below use the installed jrl-release form. If you haven't installed it, prefix-swap jrl-release → uv run --no-project jrl_release.py.

Common Commands

# Check that all files agree on the current version
jrl-release --check-version

# Bump version
jrl-release --bump patch       # 1.0.0 -> 1.0.1
jrl-release --bump minor       # 1.0.0 -> 1.1.0
jrl-release --bump major       # 1.0.0 -> 2.0.0

# Set a specific version
jrl-release --update-version 1.2.3

# Bump, commit and tag in one step
jrl-release --bump patch --git-commit --git-tag

Options

Option Description
--root <PATH> Project root (default: cwd).
--bump <major|minor|patch> Bump version component.
--update-version <X.Y.Z> Set a specific version.
--dry-run Show changes without writing files.
--short Print only the version string.
--output-format <text|json> Output format (default: text).
--confirm Skip interactive prompts.
--list-files List tracked files.
--git-commit [MSG] Commit changes. Optional message ({version} placeholder).
--git-tag [NAME] Create a tag. Optional name ({version} placeholder).
--git-tag-message <MSG> Tag annotation ({version} placeholder).

Git defaults: commit chore: bump version to {version}, tag v{version}, tag message Release version {version}.

Supported Files

File Key
package.xml <version> tag
pyproject.toml project.version
CHANGELOG.md First ## [X.Y.Z] section (not Unreleased)
pixi.toml [workspace] version and [package] version (pixi-build)
pixi.lock Regenerated via pixi list
Cargo.toml [package] version and [workspace.package] version
Cargo.lock Regenerated via cargo update --workspace
CITATION.cff version key
CMakeLists.txt project(... VERSION X.Y.Z ...)

Requires pixi CLI if pixi.lock exists in the project root, and cargo if Cargo.lock does.

Testing

The unit tests live in test_jrl_release.py and can be run two ways:

# Standalone (PEP 723 inline metadata, no install needed)
uv run --no-project test_jrl_release.py

# Via the project's test extra (from the repo root)
uv run --extra test pytest

Metadata

Release files for jrl-cmakemodules-scripts 2.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jrl-cmakemodules-scripts 2.4.0
File Size Uploaded Provenance Actions
jrl_cmakemodules_scripts-2.4.0.tar.gz 20.3 kB With provenance Details for jrl_cmakemodules_scripts-2.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jrl-cmakemodules-scripts 2.4.0
File Interpreter ABI Platform Actions
jrl_cmakemodules_scripts-2.4.0-py3-none-any.whl Python 3 none any Details for jrl_cmakemodules_scripts-2.4.0-py3-none-any.whl

Total release size: 41.5 kB

Release files / jrl_cmakemodules_scripts-2.4.0.tar.gz

Download URL jrl_cmakemodules_scripts-2.4.0.tar.gz
Size 20.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f415f2fcb70b9fc1a35634bcfa0f9a3e0ca8ee469c545e9e1faad7f6328b562c
BLAKE2b-256 checksum
How to use checksums
13965ab1dc82a30e7c15e67ad04ce4a83dd283c05886b853192c3d70550aeb08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log

Release files / jrl_cmakemodules_scripts-2.4.0-py3-none-any.whl

Download URL jrl_cmakemodules_scripts-2.4.0-py3-none-any.whl
Size 21.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f9f124d802d6f2a91c300549bf27307d103ac60f1e5ebb9cbaf178715d97b4eb
BLAKE2b-256 checksum
How to use checksums
03cc3cba14b7199e35ec486c01b8a5a694213d44e1e752f1e44d186e75318199
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log

Security for jrl-cmakemodules-scripts 2.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for jrl_cmakemodules_scripts-2.4.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 7, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page