calver-auto-release 🏷️
🏷️ Automatically create GitHub releases using Calendar Versioning (CalVer) on every commit.
This tool is perfect for:
- 📦 Packages where users should always use the latest version
- 🔬 Research software where releases are not tied to specific feature completions
- 🔄 Projects with continuous deployment where each merge to main is a potential release
- 🤖 Automating away the decision of "when should we release?"
By automatically creating a release on every commit to your main branch, you ensure that:
- Users always have access to the latest changes
- Version numbers clearly indicate when changes were made
- Each change is properly documented through commit messages
- The release process is completely automated
ToC
Features
- 📅 Automatic Calendar Versioning (
v{YYYY}.{MM}.{PATCH}) - 🤖 Creates GitHub releases automatically
- 📝 Generates release notes from commit messages
- 🏷️ Supports release skipping with commit message flags
- 🔄 Integrates with GitHub Actions
- 🐍 Can be used as a Python package
- 🖥️ Command-line interface included
- 🧪 Dry-run mode for testing
- 📋 Customizable release notes format
Usage
GitHub Action
Add this to your workflow file (e.g., .github/workflows/release.yml):
A minimal example:
name: Create Release
on:
push:
branches: [main]
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: basnijholt/calver-auto-release@v1
id: release
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
And full example including publishing to PyPI:
name: Create Release
on:
push:
branches:
- main
jobs:
release:
runs-on: ubuntu-latest
environment: # Needed for `pypa/gh-action-pypi-publish`
name: pypi
url: https://pypi.org/p/${{ github.repository }}
permissions: # Needed for `pypa/gh-action-pypi-publish`
id-token: write # for PyPI publishing
steps:
# Create release with CalVer
- uses: basnijholt/calver-auto-release@v1
id: release
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Optional: custom configuration
skip_patterns: "[skip release],[no-release]"
footer: "Custom footer text"
generate_release_notes: true # Add GitHub's automatic release notes
# Optional: publish to PyPI
# Only run if a new version was created
- name: Build package
if: steps.release.outputs.version != ''
run: |
python -m pip install build
python -m build
# Option 1: Publish with official PyPA action
- name: Publish package distributions to PyPI
if: steps.release.outputs.version != ''
uses: pypa/gh-action-pypi-publish@release/v1
# Option 2: Publish with twine
# - name: Publish package distributions to PyPI
# if: steps.release.outputs.version != ''
# env:
# TWINE_USERNAME: __token__
# TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
# run: |
# python -m pip install twine
# twine upload dist/*
The action creates a new release with CalVer versioning, and you can optionally add your preferred method for publishing to PyPI or any other post-release tasks.
CLI Usage
# Basic usage
calver-auto-release --repo-path /path/to/repo
# Dry run (show what would happen without creating the release)
calver-auto-release --repo-path /path/to/repo --dry-run
# Custom skip patterns
calver-auto-release --repo-path /path/to/repo --skip-pattern "[no-release]" --skip-pattern "[skip]"
Python API
from calver_auto_release import create_release
# Basic usage
create_release() # Uses current directory
# With custom configuration
create_release(
repo_path="/path/to/repo",
skip_patterns=["[skip]", "[no-release]"],
footer="\nCustom footer text",
dry_run=True, # Show what would happen without creating the release
)
Release Notes Format
The generated release notes will have this format:
🚀 Release YYYY.MM.PATCH
📝 This release includes the following changes:
- First commit message
- Second commit message
- etc.
🙏 Thank you for using this project! Please report any issues or feedback on the GitHub repository
Requirements
- Git repository with an 'origin' remote configured
- Python 3.10 or higher
- Git command-line tools installed
Installation
Install using pip:
pip install calver-auto-release
Or using uv:
uv pip install calver-auto-release
Configuration
Skip Release Patterns
You can skip creating a release by including these patterns in your commit message:
[skip release][pre-commit.ci]⬆️ Update
Version Format
The version format follows CalVer: YYYY.MM.PATCH
YYYY: Current yearMM: Current monthPATCH: Incremental number, resets when year or month changes
Custom Footer
You can customize the footer text that appears at the end of each release note:
create_release(
footer="\nCustom footer text for all releases"
)
Or via CLI:
calver-auto-release --footer "Custom footer text"
Or in the GitHub Action:
- uses: basnijholt/calver-auto-release@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
footer: "Custom footer text"
License
MIT License
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Development
- Clone the repository
- Install development dependencies:
pip install -e ".[dev]"
- Install pre-commit hooks:
pre-commit install - Run tests:
pytest
Metadata
Release files for calver-auto-release 1.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| calver_auto_release-1.0.8.tar.gz | 10.4 kB | With provenance | Details for calver_auto_release-1.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| calver_auto_release-1.0.8-py3-none-any.whl | Python 3 | none | any | Details for calver_auto_release-1.0.8-py3-none-any.whl |
Total release size: 31.3 kB
Release files / calver_auto_release-1.0.8.tar.gz
| Download URL | calver_auto_release-1.0.8.tar.gz |
|---|---|
| Size | 10.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
73a85237137a6a6c86a74cb0e74d0d5151c0ec18e0f121e0a4d462bec5b9def1
|
|
BLAKE2b-256 checksum How to use checksums |
9beba266abe3d95ff0f918900c8aa4ace4f17c5a09860e80d7e8b489905f3da1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 Jun 15, 2026.
Transparency logRelease files / calver_auto_release-1.0.8-py3-none-any.whl
| Download URL | calver_auto_release-1.0.8-py3-none-any.whl |
|---|---|
| Size | 20.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f50a50173efbbd84dd0247bc7c1beb60db6d657a8b7ae117ecdd7351caed593f
|
|
BLAKE2b-256 checksum How to use checksums |
c77cfd1f960ae0473da81190d8a9af899af1733d200edc033f057f5e0932379c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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 Jun 15, 2026.
Transparency logSecurity for calver-auto-release 1.0.8
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.
Attestation for calver_auto_release-1.0.8.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 Jun 15, 2026.
Transparency logA 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.