Changelog
1.8.1 (2026-11-01)
Fixes
- Fix linting issues in documentation and code snippets. c912a6b
Other
Upgrade
markdown-it-deflistto version 4.0.0 for updated features and dependencies. 475aafaMigrate documentation site from ProperDocs to VitePress. 700beae
Replace the Material for MkDocs / ProperDocs site with VitePress (#459).
- Add a VitePress project under docs/ (npm, Node 22 via .nvmrc and devenv).
- Generate the CLI and API reference at build time with a griffe/click script (docs/scripts/generate_reference.py); output is gitignored.
- Keep existing URLs by emitting each page as foo/index.html and making relative .md links absolute for rewritten pages.
- Auto-scan the sidebar from the section directories.
- Convert admonitions, tabs, collapsibles, includes, and the home page to VitePress syntax; render definition lists with markdown-it-deflist.
- Update the final-deploy and PR-preview workflows, justfile, pre-commit config, and the docs dependency group.
- Remove properdocs.yml, overrides/, gen_doc_stubs.py, custom CSS, and giscus comments.
- Switch the rumdl flavor to "standard"; this reindents nested lists in README.md.
Closes #459
1.8.0 (2026-11-01)
Fixes
Fix allow_dirty_files for renames and fold duplicated tag mismatch tests. 128dba0
A git rename is only ignored when both the old and new paths match.
Fix lint findings in new tests. 61132ba
Fix YY and 0Y calver formatting and parsing for years 2000 and 2100+. 7edb0c1
YY is now the year minus 2000, as calver.org specifies, so 2106 renders as 106. The parse patterns accept the values they render, including 0 for the year 2000.
Refs #346
New
Add tests for uncomparable and equal tag mismatch versions. 74990b1
Add allow_dirty_files setting to exempt files from the dirty check. d70acda
Files matching these glob patterns no longer make the working directory dirty, so generated files like a changelog don't require --allow-dirty.
Refs #237
Updates
Change tag mismatch warning to fire only when the version is behind the tag. 6088a9f
A current version ahead of the last tag is normal during development, so that case, and versions that can't be compared, now log at debug level.
Refs #318
Update pre-commit hooks to latest versions: Ruff v0.17.3, MyPy v2.4.1, PyDocLint v0.12.0, and Rumdl v0.3.2. 972ffcf
1.7.0 (2026-10-31)
New
- Added version placeholders in hook commands for safe execution. adc21f0
Other
[pre-commit.ci] pre-commit autoupdate. d222c27
updates: - github.com/astral-sh/ruff-pre-commit: v0.17.1 → v0.17.2
Skip POSIX quoting test on Windows. 4d7e582
Quote hook placeholder values and skip context when shell hooks allowed. 53b6700
1.6.7 (2026-10-25)
New
- Add docstrings to pyproject discovery tests. 39b2f2c
Other
Document pyproject.toml discovery by parsing and PEP 621 fallback (#363). 1db7c46
Discover pyproject.toml by parsing; fall back to PEP 621 project.version (#363). 168a7d9
1.6.6 (2026-10-25)
Fixes
Refactor: clean up line formatting and improve spelling. 07ada6f
Fix a failing bump leaving some files already changed. a8a9403
All the file changes are made in memory first and written only when every file could be changed; several changes to one file still chain. Part of #381.
co-authored-by: Claude Opus 5.5 noreply@anthropic.com
Other
Test the restore-failure, no-new-version and on-disk search paths. ea9a033
Covers the lines Codecov reported as missing in files.py for #454.
Restore files when a write fails in modify_files. 1b69816
Follow-ups to #432 (part of #381): drop the stale coverage pragma on make_file_change and document it, replace the tuple dict in modify_files with two dicts, restore already-written files when a later write raises OSError, and add tests for ignored files, write failure, make_file_change writes and do_bump leaving config untouched.
1.6.5 (2026-10-24)
Fixes
Fix: don't enable pip caching in the GitHub Action. 3245d15
setup-python's pip cache looks for requirements.txt or pyproject.toml in the caller's checkout and fails when neither exists. The action installs bump-my-version from PyPI and doesn't need the cache.
Fixes #320
Other
docs: add Python testing guidelines and examples. 5ad4106
- Introduce comprehensive testing documentation for Python using pytest.
- Include docs on fixtures, parametrized tests, mocking, temporary files, async testing, and exception handling.
- Provide TDD best practices and docstring conventions.
- Add examples and patterns for common use cases to improve test coverage and maintainability.
- Establish
docs/agents/python/for future Python-related references.
1.6.4 (2026-10-24)
Fixes
Fix: raise FileNotFoundError when a glob matches no files. a83d288
A
globfile entry that matched nothing (or whose matches were all removed byglob_exclude) was silently skipped, while a missingfilenameraised FileNotFoundError. Glob entries now follow the same rule: raise unlessignore_missing_file(or the global
Other
Test: share no-match glob parametrization and trim helper. 3b935ac
[pre-commit.ci] pre-commit autoupdate. ef27fcd
updates: - github.com/astral-sh/ruff-pre-commit: v0.17.0 → v0.17.1
1.6.3 (2026-10-18)
Fixes
Fix: close review gaps in config discovery and file resolution. aff2341
- recognise POSIX and Windows absolute paths on every platform
- raise ConfigurationError for non-mapping 'files' entries
- resolve each filemap key once in files_to_modify
- use find_repo_root for scm repository_root (git and hg)
- strengthen symlink tests, add symlinked config case
- narrow broad pytest.raises(Exception) to ValidationError
Fix: don't re-add CLI files already configured; limit '!' handling to glob_exclude. ce16247
Fix: compare CLI and configured file paths as resolved paths. f36ef5d
Also handle '!' glob_exclude negation when rebasing paths, ignore non-mapping files entries, simplify config-dir walk, and document discovery and path rules.
Other
Test: add docstrings to discovery and resolution tests. 5001ca1
Test: use posix paths for resolved filenames and skip '|' path test on Windows. b1a2d20
Test: compare resolved filename as Path for Windows separators. ad7b894
Test: expect single entry for symlinked cwd. 2635f8e
Feat: resolve config through repo parents and anchor file paths to config dir. 276dfc4
Search parent directories up to the git/hg repo root for a config file (#8). Resolve relative filename/glob from the config file's directory and add a {repo_root} placeholder (#9).
Closes #8, closes #9
1.6.2 (2026-10-18)
Fixes
- Fix the BVHOOK_NEW_TAG environment variable in hook environments. 8f0d03e
Other
Ci: exclude uv.lock from Codacy analysis. b2732f4
Chore(deps): update
uv.lockfor Python 3.10+ compatibility and dependency upgrades. 37225f8Ci: drop Python 3.9 and add Python 3.15 to test matrix. 8d46056
Ci: add Codacy exclusions and ignore local .codacy directory. 1217a32
Ci: make release work for fork PRs and skip fork-incompatible previews. 364b98c
Trigger the release workflow on push to master so merged fork PRs get a version bump with full permissions. Skip the version-hint and docs-preview workflows for fork PRs, which only get a read-only token and no secrets.
Bump
actions/upload-artifactto v7 andactions/setup-pythonto v7. ba36db7Bump python from 3.14-slim-bookworm to 3.15-slim-bookworm. cfed8a8
Bumps python from 3.14-slim-bookworm to 3.15-slim-bookworm.
updated-dependencies: - dependency-name: python dependency-version: 3.15-slim-bookworm dependency-type: direct:production
signed-off-by: dependabot[bot] support@github.com
[pre-commit.ci] pre-commit autoupdate. 0640b3e
updates: - github.com/astral-sh/ruff-pre-commit: v0.16.10 → v0.17.0
Bump
build-and-inspect-python-packageaction to version 3.0.1. 8b42383
1.6.1 (2026-10-17)
Fixes
Fix the --increment examples in the show subcommand docs. bee5795
--increment is an option of show, so it has to come after it: 'bump-my-version --increment patch show' fails with "No such option '--increment'." The examples also name new_version, so that show prints the version each one shows.
Other
Keep the repository root when HEAD is detached. 6f40aee
Since ac7b3ba, the branch is read with git symbolic-ref, which fails on a detached HEAD (the usual CI checkout). revision_info() then returned early without the repository root, so the changed files were never staged and the commit failed. Keep the root and use an empty branch name, as git branch --show-current did.
Fixes #438
[pre-commit.ci] pre-commit autoupdate. ed13388
updates: - github.com/astral-sh/ruff-pre-commit: v0.16.9 → v0.16.10
1.6.0 (2026-10-03)
New
Add --to option to set a version part to a specific value. 2ce68b3
Closes #327
1.5.3 (2026-10-03)
Fixes
- Refactor CLI tests to improve type safety and update
uv.lockdependencies to latest compatible versions. cd9fdfa
Other
Standardize string quotation in example code within update-a-date documentation. 8b42d2a
[pre-commit.ci] pre-commit autoupdate. 7a3cba4
updates: - github.com/astral-sh/ruff-pre-commit: v0.16.6 → v0.16.9
1.5.2 (2026-09-09)
Fixes
Fix git branch detection for older git versions and unborn HEAD. ac7b3ba
git branch --show-currentrequires git 2.22+; on older versions it raises an exception that is silently swallowed, causing revision_info() to return None and skip staging files before commit. Replace it withgit symbolic-ref --short HEAD, which works on git 1.x+ and also resolves correctly on an unborn HEAD (a repo with no commits yet).Fixes #426
claude-session: https://claude.ai/code/session_01NgKrJnSAZmhGvVcwH32w3z
Other
[pre-commit.ci] pre-commit autoupdate. 1efe237
updates: - github.com/astral-sh/ruff-pre-commit: v0.16.0 → v0.16.6
1.5.1 (2026-08-06)
New
- Add tests to cover new push on tag. d73288a
Other
Document
push_tagconfiguration and usage in global settings. e832c97Support pushing tag-only releases in one go. ec14558
1.5.0 (2026-07-27)
Other
Adjust logging levels and add warning for missing configuration files in tests. 4420d9e
Fixes #421
Bump the github-actions group across 1 directory with 2 updates. 0944890
Bumps the github-actions group with 2 updates in the / directory: actions/checkout and actions/setup-python.
Updates
actions/checkoutfrom 6 to 7Updates
actions/setup-pythonfrom 6 to 7updated-dependencies: - dependency-name: actions/checkout dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
[pre-commit.ci] pre-commit autoupdate. 39a2478
updates: - github.com/astral-sh/ruff-pre-commit: v0.15.17 → v0.15.22
Updates
- Update ruff directives and pre-commit hooks to latest versions. 97f5f3c
1.4.1 (2026-06-18)
Fixes
Fix colorization of CLI in docs, upgrade to latest
click-extra. ee11fb2Refs https://github.com/callowayproject/bump-my-version/issues/406#issuecomment-4731773072
1.4.0 (2026-06-17)
Fixes
- Fixed linting errors. 8196116
Other
Bump codecov/codecov-action from 6 to 7 in the github-actions group. 430128e
Bumps the github-actions group with 1 update: codecov/codecov-action.
Updates
codecov/codecov-actionfrom 6 to 7updated-dependencies: - dependency-name: codecov/codecov-action dependency-version: '7' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
[pre-commit.ci] pre-commit autoupdate. 8124a90
updates: - github.com/astral-sh/ruff-pre-commit: v0.15.15 → v0.15.17
[pre-commit.ci] pre-commit autoupdate. da390f0
updates: - github.com/astral-sh/ruff-pre-commit: v0.15.8 → v0.15.15
Bump softprops/action-gh-release from 2 to 3 in the github-actions group. f966be5
Bumps the github-actions group with 1 update: softprops/action-gh-release.
Updates
softprops/action-gh-releasefrom 2 to 3updated-dependencies: - dependency-name: softprops/action-gh-release dependency-version: '3' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Disable shell hooks in configuration defaults and models. 8a8aa51
Fixes #407
Standardize Markdown usage in documentation by replacing deprecated
:::field-listsyntax with modern///html. Adjusted configurations inmkdocs.ymland.changelog-config.yamlto align with updated formatting. 8fac9fb[pre-commit.ci] pre-commit autoupdate. 6433302
updates: - github.com/astral-sh/ruff-pre-commit: v0.15.1 → v0.15.8
Bump codecov/codecov-action from 5 to 6 in the github-actions group. b32d019
Bumps the github-actions group with 1 update: codecov/codecov-action.
Updates
codecov/codecov-actionfrom 5 to 6updated-dependencies: - dependency-name: codecov/codecov-action dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Bump actions/download-artifact from 7 to 8 in the github-actions group. 14d8fa1
Bumps the github-actions group with 1 update: actions/download-artifact.
Updates
actions/download-artifactfrom 7 to 8updated-dependencies: - dependency-name: actions/download-artifact dependency-version: '8' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Updates
Update dependency versions (
pyproject.toml,.pre-commit-config.yaml, anduv.lock); addclick-extraplugin to mkdocs configuration. c7954cbFixes #406
Update dependency versions (
anyio,click,virtualenv) and adjust constraints inuv.lockandpyproject.toml. c2cf2beFixes #410
Update workflows to use
properdocsinstead ofmkdocs; adjust linter exclusions inpyproject.toml. b63b3dcUpdate tests to mock
httpx2instead ofhttpxfor download URL functionality. cc78fd4Update dependency constraints and versions in
uv.lock. ce7be1fUpdate CHANGELOG formatting for clarity and consistency. 64a55c3
1.3.0 (2026-03-22)
Fixes
- Refactor hook script execution to handle platform-specific argument parsing; update typing imports. a46b63d
New
Add
allow_shell_hooksoption for safe hook execution; improve shell syntax handling. 036ee1a- Introduce
allow_shell_hooksconfiguration to control shell metacharacters in hooks. - Change default behavior to disallow shell syntax (
shell=False) unless explicitly enabled. - Add regex detection for shell syntax and migrate affected hooks.
- Update tests and fixtures to cover new functionality.
- Enhance documentation with migration guidance and best practices.
- Introduce
Other
Standardize formatting, spacing, and indentation across documentation and templates for consistency. 1b9eb42
Modularize CLI commands into individual files:
bump,replace,show,show-bump, andsample-config; add corresponding tests and shared options file. c35c431Make
--regexoption nullable; add tests for precedence between CLI flags and config. c78bbef
Updates
Update pre-commit, improve
is_subpathlogic, and enhance documentation. 919c66b- Update
ruff-pre-committo v0.15.1 in pre-commit config. - Refine
is_subpathlogic to handle edge cases and add path resolution. - Add security test cases for path traversal in
test_is_subpath. - Extend
AGENTS.mdwith pytest execution instructions.
- Update
1.2.7 (2026-02-14)
Fixes
- Refactor movable tag logic to delete remote tags before pushing; update tests and documentation. a0d9580
Other
[pre-commit.ci] pre-commit autoupdate. ed0b8f6
updates: - github.com/astral-sh/ruff-pre-commit: v0.14.10 → v0.15.0
1.2.6 (2025-12-29)
Fixes
Fix: Set default
is_flagvalue toFalsein click_config. 6f5d13dFix Jinja template includes to use
.jinjafile extension consistently. 13b7902
New
- Add Python 3.14 to GitHub Actions test matrix. f8ff078
Other
Bump Click dependency to version 8.3.1 for Python 3.10+. c9db946
Bump click support to <8.4. be429e8
fixes #377
Bump the github-actions group across 1 directory with 2 updates. 05edf97
Bumps the github-actions group with 2 updates in the / directory: actions/checkout and actions/download-artifact.
Updates
actions/checkoutfrom 5 to 6Updates
actions/download-artifactfrom 6 to 7
updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
[pre-commit.ci] pre-commit autoupdate. d2edfae
updates: - github.com/astral-sh/ruff-pre-commit: v0.14.6 → v0.14.10
1.2.5 (2025-12-13)
Fixes
Refactor: Simplify Mercurial test skip condition using
pytest.mark.skipif. a596f61Fix: Skip Mercurial tests if Mercurial is not available. bb5ff24
Fix README.md's workflow permissions and token usage. bf4397e
- Added explicit permissions for
id-token,pull-requests, andcontentsin the build job. - Replaced
GH_TOKENwithGITHUB_TOKENfor consistency. - Clarified documentation on using personal access tokens (PAT).
- Removed unused
MANIFEST.infile.
- Added explicit permissions for
Fix outdated link URL in docs leading to a 404. 440300a
Other
Compatibility with click 8.3, handle Sentinel values. 554922d
[pre-commit.ci] pre-commit autoupdate. 4b844b5
Bump actions/download-artifact from 5 to 6 in the github-actions group. f2613d7
Bumps the github-actions group with 1 update: actions/download-artifact.
Updates
actions/download-artifactfrom 5 to 6
updated-dependencies: - dependency-name: actions/download-artifact dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Bump python from 3.12-slim-bookworm to 3.14-slim-bookworm. 1d1d0fe
Bumps python from 3.12-slim-bookworm to 3.14-slim-bookworm.
updated-dependencies: - dependency-name: python dependency-version: 3.14-slim-bookworm dependency-type: direct:production
signed-off-by: dependabot[bot] support@github.com
[pre-commit.ci] pre-commit autoupdate. 778b8b5
updates: - github.com/astral-sh/ruff-pre-commit: v0.13.2 → v0.14.5
Updates
Remove unused Python inventory references from
mkdocs.yml. 21a0c6eRemove Python 3.8 support and comment out Mercurial installation steps on Windows in GitHub Actions workflow. 3ec922b
1.2.4 (2025-10-04)
Fixes
Fixed release hint rules. fbd3deb
- trigger release when pypproject.toml is changed
Fix mercurial install on Windows. c230f4a
Fix breaking Click dependency. 5a4073b
- Set Click required version to
<8.2.2 uv.lockregenerated with upgraded dependencies
- Set Click required version to
Other
[pre-commit.ci] pre-commit autoupdate. 1af3e18
updates: - github.com/astral-sh/ruff-pre-commit: v0.13.0 → v0.13.2
1.2.3 (2025-09-19)
Fixes
Fix
is_subpathdocstring for clarity and detailed explanation of functionality. 68041e8Refactor tests to improve readability by using Arrange-Act-Assert pattern and updating
httpservermethods. 164c99dFix: set "click<8.3" and adjust some pytest_httpserver methods to latest. 8374073
Other
[pre-commit.ci] pre-commit autoupdate. 58946b2
updates: - github.com/pre-commit/mirrors-mypy: v1.17.1 → v1.18.1
Updates
- Update
uv.lockandpyproject.tomlto refactor dependency groups and align formatting. 8b4d8aa
1.2.2 (2025-09-13)
Fixes
- Fixed code style, ensure encoding consistency, and update dependencies in pre-commit configuration. 91d5eff
Other
Bump the github-actions group across 1 directory with 3 updates. b8e2f1c
Bumps the github-actions group with 3 updates in the / directory: actions/checkout, actions/setup-python and actions/download-artifact.
Updates
actions/checkoutfrom 4 to 5Updates
actions/setup-pythonfrom 5 to 6Updates
actions/download-artifactfrom 4 to 5
updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
[pre-commit.ci] pre-commit autoupdate. 846fedd
updates: - github.com/astral-sh/ruff-pre-commit: v0.12.3 → v0.12.12
Updates
- Update dependency versions and Python compatibility markers in uv.lock. f8f33d0
1.2.1 (2025-07-19)
Other
Extend globbing functionality with EXTGLOB support in configuration utils. b7eefab
Fixes #357
[pre-commit.ci] pre-commit autoupdate. a1a2a16
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.12 → v0.12.3
1.2.0 (2025-06-07)
Fixes
Fix broken link to API. 4591652
https: //callowayproject.github.io/bump-my-version/reference/api/ is 404.
New
- Add support for short commit SHA in SCM information and hooks. ee83f99
Other
[pre-commit.ci] pre-commit autoupdate. 7f9e5c1
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.10 → v0.11.12
[pre-commit.ci] pre-commit autoupdate. d3169af
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.9 → v0.11.10
Updates
- Update Dockerfile and action metadata for enhanced GitHub Actions compatibility. 6baf7f7
1.1.4 (2025-05-21)
Fixes
1.1.3 (2025-05-17)
Fixes
Fixed issues in GitHub workflows. c900001
Fixes for CalVer auto_increment behavior. a034d5f
If
auto_incrementis explicitly set, the value is kept. Otherwise, it is set toTrue.Introduced new tests to verify CalVer component behavior with and without auto-increment enabled.
Other
[pre-commit.ci] pre-commit autoupdate. 9cb5598
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.8 → v0.11.9
[pre-commit.ci] pre-commit autoupdate. 1fa2a60
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.7 → v0.11.8
[pre-commit.ci] auto fixes from pre-commit.com hooks. f0df17d
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. 5d0dc39
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.6 → v0.11.7
[pre-commit.ci] pre-commit autoupdate. efe46e6
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.4 → v0.11.6
Updates
Update movable-version-tags.md. 16bea0c
Update movable-version-tags.md. 27cc579
The current documentation regarding moveable tags seems incorrect.
1.1.2 (2025-04-12)
Fixes
- Fix ident level when bump() or parse() throws exceptions. dd6a841
Other
[pre-commit.ci] pre-commit autoupdate. 10b76f6
updates: - github.com/astral-sh/ruff-pre-commit: v0.11.0 → v0.11.4
Testing write access. 31bab59
1.1.1 (2025-03-22)
Fixes
Fix fallback search pattern in files. 51ea69f
Refactor
_contains_change_patternmethod by removing unusedcontextparameter.Replace version config usage with
DEFAULT_CONFIGto provide correct fallback logic.Minor test update to align with changes.
Fixes lack of rendering in moveable tags. d201dff
1.1.0 (2025-03-22)
Fixes
Refactor Mercurial SCM support and improve test coverage. acd94d1
Revamped the Mercurial SCM implementation with new features including full tag retrieval, commit handling, and clean working directory assertion. Enhanced test suite with new Mercurial-specific tests for functionality and edge cases.
Fixed the test_bump_nested_regex function to use utc time. 7d33dff
Code in the test function used the machine local time instead of UTC time. This made the test fail if the user was not in UTC time, as the fixture tested against a bumped time using
utcnowAdded a recipe to justfile to run the tests and open the coverage report in a default web browser
Fix caching in action. d3b9f76
New
Added to the setup section in the contribution doc for the devenv.nix shell. f94cc27
Added devenv.nix and justfile. 653d917
Addition of devenv.nix allows developers to easily create hermetic environments in order to develop this package. This greatly simplifies the setup of the environment, and utilizes uv's tooling to create the virtual environment(s). Devenv.nix can also handle git-hooks, but that is already handled via the .pre-commit-config.yaml file.
The justfile includes some helpful starter recipes. Additional recipes can be added, such as build and publishing of the package/Docker.
Other
[pre-commit.ci] pre-commit autoupdate. a85b47f
updates: - github.com/astral-sh/ruff-pre-commit: v0.9.9 → v0.11.0
Updates
- Improved mercurial test coverage. e35eee1
1.0.2 (2025-03-08)
Fixes
Fix incorrect evaluation. 3578c87
The check for valid files to add should be
filename, notself.filesRefactor and improve test structure for file modifications. 8b52174
Consolidated and restructured tests for
modify_filesinto classes for better organization and clarity. Fixed an issue where empty file configurations were not properly ignored and enhanced filtering logic in configuration handling.Fixes #312
Other
Replace
list[str]withList[str]for Python 3.8+ compatibility. 6fb977cUpdated all instances of
list[str]with the genericList[str]from thetypingmodule to maintain compatibility with older Python versions (3.8 and earlier). This ensures consistent type annotations across the codebase.Fixes #313
[pre-commit.ci] pre-commit autoupdate. a057743
updates: - github.com/astral-sh/ruff-pre-commit: v0.9.7 → v0.9.9
1.0.1 (2025-03-04)
Fixes
Fix type hinting compatibility for 3.8. 9c2bb03
Replaced
listwithListfor type hints to ensure compatibility with earlier Python versions.
1.0.0 (2025-03-02)
Breaking Changes
- Updated the Readme. 5a621c3
New
- Added breaking change parsing. 00c4e7b
0.33.0 (2025-03-02)
Fixes
Fixed warnings in documentation. 782077d
Refactored PEP621 tests into a class. 2a4f12a
The tests are pretty much the same but renamed for clarity.
Fixed: allow omitting the current version in sample-config. 6b369fe
If the current version is explicitly left empty during the
sample-configquestionnaire, the resultingtool.bumpversiontable now lacks acurrent_versionkey, and will fall back to PEP 621project.version(if not dynamic). The instruction text specifically hints at this new functionality.
New
Add test for moveable tags. df787f1
New feature: retrieve and update the PEP 621 project version, if possible. 3032450
When determining the current version, and if
tool.bumpversion.current_versionis not set, attempt to retrieve the version fromproject.versionà la PEP 621. If that setting is not set, or if the version is explicitly marked as dynamically set, then continue with querying SCM tags.When updating the configuration during bumping, if we previously successfully retrieved a PEP 621 version, then update the
project.versionfield inpyproject.tomlas well. We always update, even if the true current version was read fromtool.bumpversion.current_versioninstead ofproject.version.The docs have been updated; specifically, the "multiple replacements in one file" howto and the reference for
current_version.The tests have been adapted: the new
pep621_infoproperty would otherwise trip up the old test output, and theNonedefault would trip up the TOML serializer. Additionally, new tests assert thatproject.version(and correspondingly, thepep621_infoproperty) is correctly honored or ignored, depending on the other circumstances.
Other
[pre-commit.ci] pre-commit autoupdate. 59e8634
updates: - github.com/astral-sh/ruff-pre-commit: v0.9.6 → v0.9.7
Updates
- Updated documentation. 8162dd8
0.32.2 (2025-02-22)
Fixes
Fixed coverage issue. b0c46a3
Refactor SCMInfo and Config imports. 49995c6
- Fixes #300 incompatibility with Nuitka compiling
Other
[pre-commit.ci] pre-commit autoupdate. b786638
updates: - github.com/astral-sh/ruff-pre-commit: v0.9.4 → v0.9.6
0.32.1 (2025-02-10)
Fixes
0.32.0 (2025-02-06)
Fixes
Refactor CLI config-file option to use @config_option decorator. cd06cbd
Replaced the manual
--config-fileoption setup with the@config_optiondecorator for cleaner and reusable configuration management. This change simplifies the code and enhances maintainability by consolidating the configuration logic.
New
Added pytest-localserver as a test dependency. c84243d
Add ConfigOption for flexible configuration. 1625248
Introduce
ConfigOptionand related utilities inbumpversion.click_configto handle configuration file paths or URLs. Includes tests for processing options, resolving paths/URLs, and handling errors inresolve_conf_locationanddownload_url.Added httpx as a dependency. 450154e
Other
[pre-commit.ci] pre-commit autoupdate. 17e8301
updates: - github.com/astral-sh/ruff-pre-commit: v0.9.3 → v0.9.4
Bump actions/setup-python in the github-actions group. c0771b0
Bumps the github-actions group with 1 update: actions/setup-python.
Updates
actions/setup-pythonfrom 5.3.0 to 5.4.0
updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Updates
Updated other subcommands with the new config_option. 279838a
Improve config resolution and add error handling for paths. 43f0435
Refactor
process_valueto handleNonevalues and raise aBumpVersionErrorfor non-existent files. Update related tests to ensure correct behavior for missing, existing, and URL-based config paths. These changes enhance robustness and user feedback in handling configuration inputs.
0.31.1 (2025-02-02)
Fixes
Fix type hinting incompatibility in Python 3.9. 96b29f5
Refactor to use Pathlike type alias for path representation
Unified path type handling across the codebase by introducing the
Pathliketype alias (Union[str, Path]). This improves readability and consistency in path-related functions and methods, reducing redundancy. Updated corresponding type annotations, imports, and tests accordingly.
0.31.0 (2025-02-01)
New
Add support for serializing SCMInfo in YAML, JSON, and output. e8611b2
Ensure SCMInfo objects can be serialized into YAML and JSON formats, improving compatibility with configuration and output displays. Updated dumper functions and tests to reflect the new changes and include SCMInfo details in the configurations.
Updates
- Update dependencies and adjust package versions. b6ed073
0.30.2 (2025-02-01)
Fixes
Fix #388 -
python3.8type hint compatibility. 5744f86This should address the following error when running
bump-my-versionin apython3.8environment:textdef is_subpath(parent: Path | str, path: Path | str) -> bool: **typeerror:** unsupported operand type(s) for |: 'type' and 'type'
Other
[pre-commit.ci] pre-commit autoupdate. ea3267a
updates: - github.com/astral-sh/ruff-pre-commit: v0.9.2 → v0.9.3
0.30.1 (2025-01-30)
Fixes
Fixing issues with 3.9 compatibility. cd2b193
Fixes #284. Add UTF-8 encoding to subprocess.run in run_command. 6c856b6
Explicitly set the encoding to "utf-8" in the subprocess.run call to ensure consistent handling of command output. This prevents potential encoding-related issues when processing command results.
0.30.0 (2025-01-26)
Fixes
New
Add handling for git path addition with new test coverage. 8ad5c82
Enhances the
Gitclass by adding theadd_pathmethod, improving control over tracked files. Includes comprehensive test cases to validate subpath handling, handle command failures, and ensure robustness against invalid inputs. Also includes minor refactoring with updated exception handling and code comments.Added tests for
utils.is_subpath. 4e993edAdd support for 'moveable_tags' configuration option. 2a2f1e6
This update introduces a new 'moveable_tags' field in the configuration model, with appropriate defaults. Test fixture files have been updated to reflect this change. This allows better handling of tags that can be relocated during versioning operations.
Add support for 'moveable_tags' configuration option. dd1efa5
This update introduces a new 'moveable_tags' field in the configuration model, with appropriate defaults. Test fixture files have been updated to reflect this change. This allows better handling of tags that can be relocated during versioning operations.
Added additional logging verbosity configuration in setup_logging. 2b420b8
Updated the logging verbosity levels to include formatting options for different verbosity levels. Added a new level (3) with detailed output including file path and line number. Refactored setup_logging to properly handle verbosity and log format settings.
Other
Merge remote-tracking branch 'origin/moving-tags' into moving-tags. a2b7bd1
[pre-commit.ci] pre-commit autoupdate. d03b1da
updates: - github.com/astral-sh/ruff-pre-commit: v0.8.6 → v0.9.2
[pre-commit.ci] pre-commit autoupdate. 584711b
updates: - github.com/astral-sh/ruff-pre-commit: v0.8.4 → v0.8.6
[pre-commit.ci] pre-commit autoupdate. c583694
updates: - github.com/astral-sh/ruff-pre-commit: v0.8.3 → v0.8.4
Bump softprops/action-gh-release from 1 to 2 in the github-actions group. 787c241
Bumps the github-actions group with 1 update: softprops/action-gh-release.
Updates
softprops/action-gh-releasefrom 1 to 2
updated-dependencies: - dependency-name: softprops/action-gh-release dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Updates
Updated some tests. 4013d86
Remove legacy SCM implementation and add new SCM tests. ddbe21e
Replaced the outdated
scm_old.pywith a focused and updated SCM implementation. Added extensive tests for the newSCMInfobehavior, path handling, and commit/tag logic, ensuring robust functionality for Git and Mercurial. Updated fixtures and test configurations accordingly.Rename
scm.pytoscm_old.pyand add new utility functions. dac965dRefactored SCM-related imports to use the renamed
scm_old.pyfor better module organization. Introducedis_subpathutility to simplify path checks and added support for moveable tags in version control systems. These changes improve code structure and extend functionality for tagging.
0.29.0 (2024-12-19)
New
Add support for specifying current version in
do_show. 878197fThis update introduces a
--current-versionoption to theshowcommand and passes it into thedo_showfunction. If provided, thecurrent_versionis added to the configuration, allowing more control over version display or manipulation.
Updates
Update README to clarify pre_n handling with distance_to_latest_tag. c027879
Revised the
parseexpression to excludepre_nand updatedserializeexamples to usedistance_to_latest_taginstead. Fixes #272
0.28.3 (2024-12-17)
Fixes
Fixed tag-name output. 0e773ec
Fixed PACKAGE env variable. 76c31c4
Fixed syntax errors in scripts. 56dfac0
Fixes missing runs-on in workflow. 5fe8ce5
Fix: resolve config path to align with the actual repository root. c872315
Fixed docs. 1d26b55
Fixed doc generation. aa95762
New
Other
Debugging the release workflow. db2eb9e
[pre-commit.ci] pre-commit autoupdate. 37c21a4
updates: - github.com/astral-sh/ruff-pre-commit: v0.8.2 → v0.8.3
Bump actions/setup-python in the github-actions group. 3dd6666
Bumps the github-actions group with 1 update: actions/setup-python.
Updates
actions/setup-pythonfrom 5.1.1 to 5.3.0
updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Updates
- Removed debug stuff. c0e7ad4
0.28.2 (2024-12-14)
Fixes
Fixed Ruff errors and workflow permissions. 11c1e42
Fixed more uv run workflows. d829276
Fixed installation of test dependencies. cbf10f2
Fixed issue with python install. 6e2da8d
Fixed GitHub workflows. 86a0a3b
Refactor warning display with Rich formatting. 2b7c905
Replace plain click-based warnings with styled Rich panels for better visibility. This enhances user experience by providing clearer and more visually organized warnings.
Refactored dependencies config. 39fed07
- Changed
project.optional-dependenciestodependency-groups
- Changed
New
- Add branch selection for github-push-action. 4ecc07c
Other
[pre-commit.ci] auto fixes from pre-commit.com hooks. 183a6f2
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. 075d0da
updates: - github.com/astral-sh/ruff-pre-commit: v0.7.4 → v0.8.2
[pre-commit.ci] pre-commit autoupdate. 6ed9f0e
updates: - github.com/astral-sh/ruff-pre-commit: v0.7.1 → v0.7.4
Bump codecov/codecov-action from 4 to 5 in the github-actions group. 4194af8
Bumps the github-actions group with 1 update: codecov/codecov-action.
Updates
codecov/codecov-actionfrom 4 to 5
updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Updates
Updated uv.lock. 09b825b
Update setup section in contributing guide. 4bc279b
Use extra dependencies specifier (referring to pyproject.toml) in the instructions, instead of requirements txt files (which were removed in previous commits).
0.28.1 (2024-11-03)
Fixes
- Fix format arg help text for show command. cf65ec2
Other
[pre-commit.ci] pre-commit autoupdate. 9fb0347
updates: - github.com/astral-sh/ruff-pre-commit: v0.6.9 → v0.7.1
Output hooks scripts by default. 0a042aa
Skip scm tests if the command is not installed. 2e68517
0.28.0 (2024-10-16)
New
Added container labels and version hooks. d4cb8f2
Add Docker support and configure Dependabot for Docker updates. 0315db4
Introduce a Dockerfile for containerized environments and add a .dockerignore file to exclude unnecessary files. Also, update dependabot.yml to include daily checks for Docker image updates.
Add
inputssection in GHA workflow example. 813e7f5
Other
Switch from ADD to COPY in Dockerfile. a5fc5c0
This change updates the Dockerfile to use the COPY instruction instead of ADD. COPY is preferred when only copying files because it is more explicit and simpler.
[pre-commit.ci] pre-commit autoupdate. 7c48f98
updates: - github.com/astral-sh/ruff-pre-commit: v0.6.8 → v0.6.9
Updates
- Changed dependency manager to uv. cce9e1d
0.27.0 (2024-10-06)
Fixes
Fixed test to look for warning logs. 538c420
Refactor and enhance error handling. c84bfa7
Updated subprocess calls to disable check, refined lint configurations, fixed type annotations and exceptions, and improved dictionary path validation.
New
Add HookError for failed hook execution with tests. 39fc233
Raise HookError when a hook script exits with a non-zero status. Modified logger to display warnings instead of debug messages in such scenarios. Added tests to ensure exceptions are raised for failed hooks.
Other
[pre-commit.ci] pre-commit autoupdate. 130478d
updates: - github.com/astral-sh/ruff-pre-commit: v0.6.5 → v0.6.7
Create FUNDING.yml. 2bda200
0.26.1 (2024-09-14)
Fixes
Fixed missing new version info in some hook environments. 24a9bdc
Introduce the
new_version_envfunction and update existing functions (get_setup_hook_envandget_pre_commit_hook_env) to include new version environment variables. Added new tests for verifying the inclusion of OS, SCM, current, and new version information in hook environments.
New
Add current and previous version outputs to the GHA. 0650ca8
Add environment variable to README example. 88c9790
Add GitHub action with support for commit/tag push workflow trigger. 2cdb742
Other
[pre-commit.ci] pre-commit autoupdate. d21d6df
updates: - github.com/astral-sh/ruff-pre-commit: v0.6.2 → v0.6.4
[pre-commit.ci] pre-commit autoupdate. b6773ac
updates: - github.com/astral-sh/ruff-pre-commit: v0.5.7 → v0.6.2
Updates
Updated pre-commit versions. 6f5d56b
Update example to better showcase the GHA capabilities. e3ff9a1
Update README.md. f280371
0.26.0 (2024-08-19)
Fixes
New
Added hook suite documentation. b73a6e1
Added hooks to bump command. 3b638e0
Added tests for hooks. 8446567
Add hooks configuration fields. d6b24f0
Introduced
setup_hooks,pre_bump_hooks, andpost_bump_hooksfields to configuration models. Updated corresponding test fixtures to verify these new fields.Add current_tag field to scm_info. 304c599
Updated the scm_info structure to include a new field, current_tag, across various configuration files and source code. This ensures that the current tag is tracked and represented in the output formats correctly.
Other
Enhance hook handling and testing across hook types. 49f1953
Introduced unified handling for setup, pre-commit, and post-commit hooks, including dry-run support.
Added comprehensive tests to ensure the correct behavior for all hook phases, including cases where no hooks are specified or in dry run mode.
Updated environment setup to use a common version environment function.
[pre-commit.ci] pre-commit autoupdate. 4342198
updates: - github.com/astral-sh/ruff-pre-commit: v0.5.6 → v0.5.7
Updates
Changed the terminology for hooks. 049b470
Change pre-bump and post-bump to pre-commit and post-commit to better indicate their order of operations.
0.25.4 (2024-08-14)
Fixes
Fixed terminology in tests. 0338da2
Updated test parameter and assertion messages to use "version component" instead of "version part" for clarity and consistency. This change affects the test cases that detect bad or missing version inputs.
Fixed documentation layout. 57958ea
Fixed inconsistent terms in docstrings. dfdf23e
- Switched from using both version parts and version components to simply version components.
Updates
0.25.3 (2024-08-13)
Fixes
Refactor version parsing in visualize function. 5f25300
Simplify the version parsing process by utilizing the raise_error parameter in the parse method, removing the need for a separate error check. This change ensures that parsing errors are immediately raised and handled cleanly within the visualize function.
Refactor and rename
version_parttoversioning.version_config. 5b90817Moved
version_part.pytoversioning/version_config.pyand updated all import statements accordingly. Enhanced error handling inVersionConfigby addingraise_errorflag and relevant exception raising for invalid version strings. Refined tests to reflect these changes.Fix version visualization and add verbose logging. ad46978
Raise an exception for unparsable versions and aggregate visualization output in a list before printing. Add a verbose logging option to the
show_bumpcommand for detailed logging control.
0.25.2 (2024-08-11)
Fixes
Fix JSON serialization. d3f3022
Extended the default_encoder function to handle Path objects by converting them to their string representation. This ensures that Path objects can be properly serialized to JSON format.
0.25.1 (2024-08-07)
Fixes
Fixes mypy pre-commit checking. f7d0909
Fixes repository path checks. ff3f72a
Checked for relative paths when determining if the file was part of the repo or not.
Fixed test to use globs. 72f9841
Other
[pre-commit.ci] pre-commit autoupdate. 58cc73e
updates: - github.com/astral-sh/ruff-pre-commit: v0.5.5 → v0.5.6
0.25.0 (2024-08-06)
Fixes
Refactor error handling and improve logging in utils. 890b692
Extracted error formatting to a dedicated function and applied it across the codebase. Improved command path handling in
add_pathand enhanced test coverage with necessary imports and logging configurations.Fix dictionary merging in SCMInfo. 5fb5ef2
Replaced the bitwise OR operator with the update method for merging dictionaries for 3.8 support
Refactor SCM info retrieval and config file update checks. 500ecd3
Replaced ChainMap with MutableMapping in function signatures and types. Enhanced SCM info handling by splitting code into dedicated methods for commit and revision info retrieval. Added logic to prevent config file updates when the file is outside the repo and implemented corresponding test.
New
Add repository_root field and refactor subprocess handling. 25670d0
Introduced the
repository_rootfield to store the root path of the repository in the data classes. Refactored subprocess handling to use a newrun_commandutility for improved readability and error handling consistency. Removed unnecessary dependency from.pre-commit-config.yamlto streamline dependencies.
Other
Simplify run_command return type. b91224e
Changed the return type of run_command from CompletedProcess[str] to CompletedProcess. This was done to remove unnecessary type specificity and ensure compatibility with different Python versions. The update maintains functionality and improves code readability.
[pre-commit.ci] pre-commit autoupdate. e0ba544
updates: - github.com/astral-sh/ruff-pre-commit: v0.5.2 → v0.5.5
0.24.3 (2024-07-17)
Fixes
Fix KeyError in TOML file handling. f3c328a
The code has been updated to handle KeyErrors when updating TOML files. If a KeyError is raised, it's now caught and managed depending on the file_change attributes 'ignore_missing_file' or 'ignore_missing_version'. This aims to provide more robust handling of edge cases in TOML files. In addition, a new test case has been added to ensure current version is not required in the configuration.
Fixes #212
Other
[pre-commit.ci] pre-commit autoupdate. 536c7b1
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.10 → v0.5.2
0.24.2 (2024-07-03)
Fixes
Fixed tag version extraction. 67eea3d
The output of
git describeuses-as a delimiter. Parsing tags caused splits in the parsing of version numbers.This joins all the remaining parts of the
git describewith a-.Fixed pydoclint configuration. 0386073
0.24.1 (2024-06-26)
Fixes
Refactor error handling in SCM and add error handling test. 7ca6356
This commit includes a new test in test_scm.py to verify the correct formatting and raising of subprocess errors in the SCM module. Additionally, the subprocess error handling has been refactored in the SCM module to include a new method, format_and_raise_error, for improved code readability and reusability.
Other
[pre-commit.ci] pre-commit autoupdate. 60acc2d
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.9 → v0.4.10
0.24.0 (2024-06-25)
New
Add VersionNotFoundError test in test_bump.py. cb050a8
The code in test_bump.py file has been modified to include a test for VersionNotFoundError exception. This ensures that the implementation properly handles cases where a specified version could not be found.
Add test for no commit on modification error. 7527029
A test has been added to the bumpversion library to ensure that no commit and tag is made if there is an error modification. Specifically, the test checks the "do_bump" function and asserts that "mock_commit_and_tag" and "mock_update_config_file" are not called under these conditions.
Other
[pre-commit.ci] pre-commit autoupdate. 0e3a154
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.8 → v0.4.9
Updates
Improve error message for SCM command failures. 8f72f86
The error message for failures in the SCM command execution has been enhanced. Now it displays not only the command's return code but also the standard output and error, improving the debugging process.
0.23.0 (2024-06-14)
Fixes
Refactor valid_bumps and invalid_bumps to include_bumps and exclude_bumps. 2df57cc
The configuration parameters
valid_bumpsandinvalid_bumpswere renamed toinclude_bumpsandexclude_bumpsrespectively. This new naming better denotes their function, and the changes were consistently applied across all related files and tests. Numerous fixture outputs were also updated to reflect these changes.Fixed spelling in CODE_OF_CONDUCT.md. 254ea44
New
Add file filtering based on valid and invalid bumps. f9f7f96
This commit introduces the ability to filter files based on whether the specified bump type is valid or not. It adds
valid_bumpsandinvalid_bumpslists in the file configurations and adjusts the bumping process to consider these configurations. Tests are updated to reflect these new handling of valid and invalid bumps.Add new files to .gitignore. 34e4dc1
Several new file types have been added to .gitignore for ignoring during commits. These include '.python-version', 'requirements-dev.lock', and 'requirements.lock' files.
Add valid_bumps and invalid_bumps to file configuration. 9458851
Updated the configuration file model to support valid_bumps and invalid_bumps. This feature provides control over which version section updates can trigger file changes. Adjusted various test fixtures and cleaned up tests to match these changes. Also, some updates were made to the documentation accordingly.
Other
[pre-commit.ci] pre-commit autoupdate. e44f6af
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.4 → v0.4.8
Updates
Update documentation for clarification. 2224808
The changes made update the wording in the documentation to clarify the roles of
include_bumpsandexclude_bumpsin the bump-my-version configuration. Additionally, unnecessary repetition was removed and overlapping examples were also corrected.Update docs/reference/configuration.md. 7c801c0
co-authored-by: wkoot 3715211+wkoot@users.noreply.github.com
0.22.0 (2024-06-11)
New
Add extensive documentation for the 'show' subcommand. 91409d8
This commit adds extensive documentation for the
showsubcommand in the program's reference. It also includes smaller updates and corrections to other parts of the documentation. An in-depth example usage ofshowis added both to the dedicatedshow.mdfile and in the function's docstring.
Updates
- Renamed version workflow to release. 68f9eee
0.21.1 (2024-05-16)
Other
[pre-commit.ci] auto fixes from pre-commit.com hooks. 1b57c2b
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. e813eda
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.3 → v0.4.4
[pre-commit.ci] pre-commit autoupdate. 05a0dd6
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.2 → v0.4.3
Updates
- Update README.md. cad7096
0.21.0 (2024-05-01)
Fixes
Fixed a bug in the glob tests. 1041fe9
Was not properly looking in the correct relative directories.
Fixed test for Windows glob paths. ea45c4c
Fixed exclusion logic with wcmatch. 1c391be
Refactored glob matching to use the wcmatch library. bbf4ae0
New
Adds
glob_excludefile specification parameter. 420e3bdUser can prune the files resolved via the
globparameter.Fixes #184
Other
[pre-commit.ci] pre-commit autoupdate. ce02aa7
updates: - github.com/astral-sh/ruff-pre-commit: v0.4.1 → v0.4.2
0.20.3 (2024-04-26)
Fixes
Fixed test logging setup. 3777f27
Fixed the indentation problem. ec3cd99
- Added a dedent when a file does not match the change pattern.
- Fixes #181
Other
[pre-commit.ci] pre-commit autoupdate. e916f87
updates: - github.com/astral-sh/ruff-pre-commit: v0.3.7 → v0.4.1
0.20.2 (2024-04-23)
Fixes
Fixed the rendering of numeric version components. c522c75
- Numeric version components now will attempt to render its value as an integer and fall back to the parsed value.
Fixed code block in the README. b4ff9f3
Other
[pre-commit.ci] pre-commit autoupdate. 9b09da8
updates: - github.com/astral-sh/ruff-pre-commit: v0.3.5 → v0.3.7
0.20.1 (2024-04-13)
Fixes
Fix typos discovered by codespell. d5c33a3
Fixed relative references. 2aa1011
Refactored the docs. b63a9e7
Other
[pre-commit.ci] pre-commit autoupdate. f438bc6
updates: - github.com/astral-sh/ruff-pre-commit: v0.3.4 → v0.3.5
Pre-commit: Discover typos with codespell. 2509fc7
Related to:
- #168
[pre-commit.ci] pre-commit autoupdate. be5cb79
updates: - github.com/astral-sh/ruff-pre-commit: v0.3.3 → v0.3.4
0.20.0 (2024-03-27)
Fixes
- Refactored context into its own module. 5a3e05d
New
Added
always_incrementattribute for parts. 53ee848This is a requirement for CalVer to ensure they always increment with each bump, but it will work for any type.
Added CalVer function and formatting. 7a0e639
- Version parts now have a
calver_formatattribute for CalVer parts.
- Version parts now have a
Updates
- Updated the documentation. 607609d
0.19.3 (2024-03-23)
Fixes
Fixed packaging of dev releases. 84254e0
Fixed platform-dependent encoding. f8b4d65
- Added
encoding="utf-8"to all writes.
- Added
Fixed version.yaml workflow. 10b007c
Other
[pre-commit.ci] pre-commit autoupdate. e92000a
updates: - github.com/astral-sh/ruff-pre-commit: v0.3.2 → v0.3.3
Bump the github-actions group with 3 updates. a422c58
Bumps the github-actions group with 3 updates: actions/checkout, actions/setup-python and codecov/codecov-action.
Updates
actions/checkoutfrom 3 to 4Updates
actions/setup-pythonfrom 4 to 5Updates
codecov/codecov-actionfrom 3 to 4
updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major dependency-group: github-actions
signed-off-by: dependabot[bot] support@github.com
Keep GitHub Actions up to date with GitHub's Dependabot. 2e55fa1
0.19.2 (2024-03-16)
Fixes
0.19.1 (2024-03-16)
Fixes
- Fix commas in legacy multiline options. 62dfe8e
New
- Added manual version bumping in the GitHub action. c9d67b5
Other
[pre-commit.ci] pre-commit autoupdate. be1a568
updates: - github.com/astral-sh/ruff-pre-commit: v0.2.2 → v0.3.2
0.19.0 (2024-03-12)
Fixes
- Fixing version hint generation. ae1732b
Updates
Removes ability to call the CLI without subcommand. e56c944
BREAKING CHANGE: You must use bump-my-version bump
0.18.3 (2024-02-25)
Fixes
Fixed --ignore-missing-version and --ignore-missing-files options. 7635873
The CLI options were defaulting to
Falsewhen missing. This overrode the configuration.Fixes #140
0.18.2 (2024-02-25)
Fixes
- Fixed docs and cli help. 8ac1087
0.18.1 (2024-02-24)
Fixes
Fixed type annotation in config. 2988ede
Fixed naming issue for docs. 2850aa7
- renamed changelog.md and contributing.md
New
Added how-to doc. 68643a9
- "How to update a date in a file"
Other
[pre-commit.ci] pre-commit autoupdate. c495d3d
updates: - github.com/astral-sh/ruff-pre-commit: v0.2.1 → v0.2.2
Updates
- Updated docs and styles. f4f75fa
0.18.0 (2024-02-18)
New
Added
--ignore-missing-filesoption to bump. fcfaac7Added configuration option
ignore_missing_files. b473a19
Other
0.17.4 (2024-02-10)
Fixes
Other
[pre-commit.ci] pre-commit autoupdate. 491b4aa
updates: - github.com/astral-sh/ruff-pre-commit: v0.1.14 → v0.2.0
0.17.3 (2024-01-29)
Fixes
Refactored VersionComponentConfig to VersionComponentSpec. b538308
More consistent with VersionSpec
New
- Added mental model documentation. 5cbd250
Other
[pre-commit.ci] pre-commit autoupdate. a2a3fe6
updates: - github.com/astral-sh/ruff-pre-commit: v0.1.11 → v0.1.14
Updates
- Updated more documentation. 779c84c
0.17.2 (2024-01-27)
Fixes
Fixed some tests. 593a4ee
Refactored serialization. 0ac2cd8
- Moved serialization from VersionConfig to version.serialization
Fixed extra capture group in PEP440 parser. 384fd99
Refactored verioning models. 88e7f71
- created a "conventions" module for future release
- added an optional
depends_onversion component configuration - The
depends_onis required for PEP440 versioning
Fixed None as value for a function. f8c4d05
- Turns None into an empty string
Fixed bad imports. 5c86d51
Refactored versioning models and tests. 7d05414
Refactored version parsing. 5ed546b
Refactored versioning functions and version parts. be87721
Fixed timezone of a test. 0e01253
0.17.1 (2024-01-25)
Fixes
0.17.0 (2024-01-22)
Fixes
Fixed Py3.8 type annotation. c15b23b
Fixed some output in visualizing. 406f97a
Fixed bad type annotation. 8f4bedf
Fixed bad test imports. a74342b
Refactored the create subcommand. f529d28
- Also organized the CLI tests
New
Added
show-bumpsubcommand. 0bbd814- Shows possible resulting versions of the
bumpcommand
- Shows possible resulting versions of the
Added sample-config feature. 3d0f67d
- Initial implementation
Updates
- Updated documentation. 4f90348
0.16.2 (2024-01-13)
Fixes
Fixed a bad import. 46c9c48
Fixed extra whitespace added when updating pyproject.toml. 839f17f
Removed dotted-notation from requirements. There is an issue on how dotted-notation sets values in the TOMLkit data structure.
Added
get_nested_valueandset_nested_valueas replacements for dotted-notation.
Other
[pre-commit.ci] pre-commit autoupdate. ee4d2f3
updates: - github.com/astral-sh/ruff-pre-commit: v0.1.9 → v0.1.11
0.16.1 (2024-01-06)
Fixes
Fixed empty string replacement bug. d9965ab
Only a missing replacement value will trigger one of the fallback options.
Fixes #117
0.16.0 (2024-01-05)
New
- Add support for legacy multiline search options (refs #98). 278eae5
Other
[pre-commit.ci] pre-commit autoupdate. 2e9a400
updates: - github.com/astral-sh/ruff-pre-commit: v0.1.7 → v0.1.9
0.15.4 (2023-12-29)
Fixes
Fix not being able to tag without also committing. 753c990
Fixed testing automation. 19215f1
- The new commit/tag decoupling requires the
--no-tagflag
- The new commit/tag decoupling requires the
0.15.3 (2023-12-18)
Fixes
Fix miscast of current_version. b8ea252
- When using the legacy configuration format, a single-digit version is parsed as an int
Fixes #99
0.15.2 (2023-12-18)
Fixes
Fixed regression in config update. 2bbbd74
Fixes #108
New
- Added a test case for line-start regexes. ef4823c
0.15.1 (2023-12-18)
Fixes
Fixes workflow triggers. 690452e
Fixes mismatched artifact up/downloading versions. 3f61742
Fixed PR_NUMBER retrieval. 85a8b48
Fixes committing and download-artifact. 12ba54f
Refactored workflows. d2f30a8
Other
Updates
- Changed the triggers to cause runs. 23e6c18
0.15.0 (2023-12-16)
Fixes
- Fixed requirements for github action. d96e07a
Updates
Changed default regex CLI value to None. 93191f3
Fixes #64
The default value of False was overriding other values.
0.14.0 (2023-12-15)
Fixes
Fixed issue when adding files. 84556f8
Fixed missing requirement in GH action. 42bab83
Fixed regression regarding multiple changes in one file. e7a7629
Changed the method of marking changes from a dict keyed by the file name to a list of FileChanges.
FileChanges encapsulate a single change to a file.
Refactored logging to provide indented output. 4e68214
Refactored FileConfig to FileChange. 249a999
This better describes what the class does: describe a file change.
Also moved
get_search_patternto the class, since it is specific to each instanceRefactored config file management. a4c90b2
Moved the INI format stuff into files_legacy.py
Fixes generate-requirements.sh to upgrade. 121ef69
New
Added caching to the resolved filemap. c96e0bd
Added custom GitHub action. 4ce17a9
Added indented logger to improve console output. d1d19e3
Updates
Changed the management of file changes. 909396d
File changes are hashable to weed out duplication.
Removed some commented lines. 89686b8
0.13.0 (2023-12-06)
Fixes
Fixed import of extract_regex_flags. a980670
Fixed logging and regex regression in 3.11. cae12dc
Fixed issue with tag name. e218264
Fixes #74
current_version and tag_name now do not need to match exactly
Fixed logic in auto bump workflow. 909a53f
Fixes https://github.com/callowayproject/bump-my-version/issues/85. 97049e0
HG returns the tags in the order they were created so we want the last one in the list
Fixed autoversioning. a308a35
New
Added key_path to FileConfig. e160b40
- Also made all attributes required except
filename,glob, andkey_path
- Also made all attributes required except
Other
[pre-commit.ci] auto fixes from pre-commit.com hooks. 8188a42
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. 4c81ad4
updates: - github.com/astral-sh/ruff-pre-commit: v0.1.3 → v0.1.5
[pre-commit.ci] pre-commit autoupdate. 7109d70
updates: - github.com/astral-sh/ruff-pre-commit: v0.1.3 → v0.1.6
Updates
Refactored configuration file updating. e407974
TOML files are parsed, specific values are updated, and re-written to avoid updating the wrong data.
It uses a two-way parser, so all formatting and comments are maintained.
INI-type configuration files use the old way, since that format is deprecated.
0.12.0 (2023-11-04)
Fixes
Fixed versioning. 8769671
Fix dev versioning with PR number. 463082b
Fix dev versioning. 1eed99b
- added an echo of the PR_NUMBER
Fix versioning of development versions. e89599f
Fixes workflows. 5ebb0d7
Fixed bug #65 where glob'd files weren't used. 357b9dc
New
Add -h for help option. fda71b0
Fixes #67
Other
Drop Python3.7 as compatible version. 890edc8
Since this is no longer tested, it's safer to start at 3.8.
[pre-commit.ci] auto fixes from pre-commit.com hooks. fbcef03
for more information, see https://pre-commit.ci
Recommend calling 'bump-my-version' instead of 'bumpversion'. 9fb1a1d
[pre-commit.ci] pre-commit autoupdate. e2579d6
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.290 → v0.0.292
[pre-commit.ci] pre-commit autoupdate. e21fdd9
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.290 → v0.1.1
[pre-commit.ci] pre-commit autoupdate. 7e5d1bc
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.290 → v0.1.3
Updates
Changed the default regex search to non-regex. 0034716
Fixes #59
- Changed the flags to --regex/--no-regex
- updated tests and docs
0.11.0 (2023-09-26)
Other
[pre-commit.ci] pre-commit autoupdate. 4a3d046
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.285 → v0.0.290
Updates
Removed bumpversion as a duplicate of the bump-my-version script. a59ced8
Updated dependency from Pydantic 1 to 2. 577aa4c
0.10.0 (2023-09-05)
Updates
Refactored file resolution, inclusion, and exclusion. 646af54
- Fixes #61
- Config now includes
resolved_filemapproperty - resolved filemap expands all globs
- Config now includes
files_to_modifyproperty - files to modify resolves inclusions and exclutions
- Improved Config.add_files property
0.9.3 (2023-08-25)
Fixes
Fixed file configuration overrides. c1ef3b2
Fixes #55
The file config was ignoring falsey values when constructing the dict.
It now ignores
Nonevalues.Fixed documentation regarding regex config. cd71a1a
- TOML requires the double backslash while INI doesn't
Fixed requirements for docs. 7856ee0
New
- Added documentation building workflow. 48980d7
Other
[pre-commit.ci] pre-commit autoupdate. 7c38c40
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.284 → v0.0.285
[pre-commit.ci] pre-commit autoupdate. c30bd12
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.282 → v0.0.284
[pre-commit.ci] pre-commit autoupdate. 95c89fb
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.281 → v0.0.282
Updates
- Removed mentions of Python 3.7. a91f690
0.9.2 (2023-08-07)
Fixes
Fixed modified context when committing. 130bbe0
- Resets the context before committing and tagging
- Fixes #14
0.9.1 (2023-08-03)
Other
[pre-commit.ci] auto fixes from pre-commit.com hooks. 4b457d0
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. adb7e4c
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.277 → v0.0.281
Updates
Remove
pygments_stylefrom docsrc/conf.py. 32798a9The theme defaults, subjectively, look better.
0.9.0 (2023-08-03)
New
Added documentation about regular expressions. 449b70a
Added configuration and command-line
no_regexoption. a295a32- Global and individual file configurations available for
no_regex - Command-line flag
--no-regexflag added forbumpandreplacesub-commands
- Global and individual file configurations available for
Adds regular expression searching ability. 0210d74
- Search strings are treated as regular expressions after the initial substitution
Added deprecation warning on .cfg files. a0481b7
0.8.0 (2023-07-13)
New
Added documentation for ignore missing version. e0731c3
Added
--ignore-missing-versionflag tobumpandreplace. a5bd008Added
ignore-missing-versionconfiguration. 45c85be- Defaults to
False - File configurations can also override this value
- Defaults to
Added deprecation warnings. 733438b
--listoption will go bye-bye in 1.0- calling
bumpversionwithout a subcomand will leave in 1.0
0.7.1 (2023-07-12)
Fixes
Fix search and replace options for replace. 781e8d8
- The
--searchand--replaceoptions now completely override any other search and replace logic.
Fixes #34
- The
Other
[pre-commit.ci] pre-commit autoupdate. 531738d
updates: - github.com/astral-sh/ruff-pre-commit: v0.0.276 → v0.0.277
[pre-commit.ci] pre-commit autoupdate. 61e6747
updates: - https://github.com/charliermarsh/ruff-pre-commit → https://github.com/astral-sh/ruff-pre-commit
0.7.0 (2023-07-10)
Fixes
Fixed test coverage. 3fe96f0
Fixed wrong pydantic version pinning. d4b125e
Fixed typing issue. bfe5306
- Declared SourceCodeManager attributes as
ClassVar[List[str]] _TEST_USABLE_COMMAND,_COMMIT_COMMAND, and_ALL_TAGS_COMMANDaffected
- Declared SourceCodeManager attributes as
New
Added tests for CLI replace command. a53cddc
Added and re-organized documentation. c62d65e
Added replace subcommand. 8722a0f
Works just like
bumpbut- doesn't do any version incrementing
- Will not change the configuration file
- Will not commit or tag
Can use
bumpversion show new_version --increment <versionpart>to see what the new version would be
Adds
short_branch_nameto version rendering context. 7f7e50cshort_branch_nameis the branch name, lower case, containing only a-z and 0-9, and truncated to 20 characters.
Fixes #28
Other
Check config before tagging. 3a6e3ee
Format version parts. ee43bdb
[pre-commit.ci] auto fixes from pre-commit.com hooks. 5e6f566
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. f1acd35
updates: - github.com/charliermarsh/ruff-pre-commit: v0.0.272 → v0.0.275
0.6.0 (2023-06-23)
Fixes
Fixed
--helpandbumpinvocations. 9d965e5--helpworks for individual sub-commands, but not for the commandbumpnow works and fixed tests
Fixed issue regarding TOML types. 8960d24
tomlkit.parse()returns aTOMLDocument.unwrap()converts it into adict
New
Adds
branch_nameto SCM information. 173be1aAdded documentation for the show command. d537274
Adds
--incrementoption toshowsubcommand. b01fffc- when specified it increments the current version and adds
new_versionto the available output.
- when specified it increments the current version and adds
Added
showsubcommand. 9bce887- supersedes the
--listoption - provides much more capability
- Can output in YAML, JSON, and default
- Can specify one or more items to display
- Can use dotted-notation to pull items from nested data structures.
- supersedes the
Updates
Changes bump-my-version into subcommands. 31ffbcf
- Is backwards-compatible with previous versions
bump-my-versionforwards command tobump-my-version bumpsubcommand- Only problem is that Click will not show help automatically, must provide
--help
0.5.1 (2023-06-14)
Fixes
Fixes reporting the wrong version missing in a file. efb04e9
- Fixes issue #20
- Renders the correct
current_versionfor each file being modified.
Other
[pre-commit.ci] auto fixes from pre-commit.com hooks. 5476cdf
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. 6e500c2
updates: - github.com/charliermarsh/ruff-pre-commit: v0.0.270 → v0.0.272
0.5.0 (2023-06-12)
Fixes
Fixed ruff complaints about subprocess. c429c68
Fixed issue with formatting. da7544f
There is an underlying edge case where the deriving previous environment variables with multiple ways of formatting version numbers will fail.
New
Add test to reproduce issue #14. d78ff46
Added documentation for replacing strings in different files. 893ec03
Fixes #6
Other
Made
VERSION_PARToptional. f236b7d- Fixes #16
VERSION_PARTis detected from the arguments based on the configuration
Updates
Updated docs indicated VERSION_PART is optional. 22edeac
Updated tests for bad version parts. 23be62d
Changed exception type raised when bad version part is detected. 1e3ebc5
- ValueError -> click.BadArgumentUsage
Updated readme. 7780265
Fixes #7
0.4.1 (2023-06-09)
Fixes
Fixes release.yaml. 01870d5
Outputs the notes to a file instead of an environment variable.
Other
[pre-commit.ci] auto fixes from pre-commit.com hooks. 266002f
for more information, see https://pre-commit.ci
[pre-commit.ci] pre-commit autoupdate. edc444f
updates: - github.com/charliermarsh/ruff-pre-commit: v0.0.261 → v0.0.270
0.4.0 (2023-04-20)
Fixes
Fixed pre-commit hook for dependency checking. 3d5c253
Fixed installing test dependencies. c1034eb
Fixed dependency spec. 4782745
Fixed missing python in pypi test. e5ed27d
Fixed some CI issues. d4b03d7
Fixed vague commit and tagging info. 4fb5158
If commit is configured false, it will report that it will not commit
If commit is configured false, tagging is disabled and it reports that
If tagging is configured false, it will report it is not tagging
Fixes test package. 7c12072
- The build-and-inspect action didn't save the dist packages
New
Added tests for logging branches. f8f0278
Added path restrictions on release-hints. e1af658
Added test build to CI. 8738f3f
Added doc files to table of contents. 49858c0
Other
Completely migrated setuptools to use pyproject.toml. f10f8b2
[pre-commit.ci] pre-commit autoupdate. d626f7d
updates: - https://github.com/python/black → https://github.com/psf/black
Updates
Removed pre-commit dependency hook. ac6cdd0
Changed the version serialization. c529452
- can bump "dev" to get a development release
Updated formatting documentation. 8006f3e
0.3.0 (2023-04-17)
Fixes
Fixed bug in SCMInfo setup. e8fddc9
Fixed missing xml coverage report. 696503f
Fixed assertion in failing test. 7afe58c
Fixes issue when new version equals current version. 64b0de3
- Now it reports they are the same and exits.
Fixes issue of duplicate tags. c025650
- Now it checks if the tag exists and reports a warning
Fixed automation tooling. 19f13b7
- changed name to bump-my-version in setup.cfg
- added PAT in release pipeline to (hopefully) allow committing and tagging to master without issue.
New
- Added codecov to workflow. a5009e0
Other
- Migrated setuptools metadata to pyproject.toml. 0bd54dc
Updates
0.2.0 (2023-04-14)
Fixes
Fixed configuration to allow_dirty in bumpversion. b042e31
Fixes issue with generate-changelog and git. 2a977af
Fixes the quoting in the bumpversion expressions. 9a55d6d
Fixed issue with windows testing. b8abc44
- different methods for reporting paths was resolved by casting them the pathlib.Paths
Fixes windows testing error. 556853b
- the differences in path specifications seems to be causing problems.
Fixed type issue in Python 3.7, 3.8. ddfd3bf
Fixed configuration file detection. fbf85c2
Doesn't just stop when it finds one, it checks for the existence of the header.
Fixed logging output and output in general. 0aea9dc
New
Added additional option to manual runs: verbose. 81eb097
Added new workflows. a9cac5b
Added bumpversion.yaml to increase the version when a PR is closed
Added release.yaml to create a github release and upload things to PyPI
Added PYTHONUTF8 mode. 91a73e2
Added explicit environment variable declarations. 80fe7ef
Added a github CI workflow. 2b3b358
Added files for coverage to ignore. cfbba08
- main.py
- aliases.py
Added LICENSE. 34a9be5
Added tests for version parsing errors. 71a204b
Added utf8 test in files. 9cb8f60
Added more tests for scm. fe794dd
Added --list function. 88709fd
Other
Removing testing for Python 3.7. 19eaeef
Moved configuration to pyproject.toml. d339007
Initial conversion. f5d1cab
Initial commit. d7dec79
Updates
Updated workflows. 857835d
- Added better changelog parsing
- Added workflow dispatch inputs for manual runs
Improved documentation. f3b7a0f
Renamed tox job to test. a9b6db3
Updated README and other documentation. e0cebb3
Improved Mercurial support. 560999d
Improved logging output. 6ccfa7d
Changed errors to subclass UsageError. a447651
Changed BaseVCS to SourceCodeManager. 11c5609
Just for consistency.
Modified the group command back to a single command. 6d4179b
Will eventually change to a group command, but later.
0.1.0 (2023-03-24)
- Initial creation