All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Python version
3.12
tested during CI - Python version
3.12
added to package classifiers
- Explicit coerce configuration file lists to sets.
- Use hatch for build backend.
- Minimum version of
GitPython
raised to3.1.35
to address a security issue.
- Documentation link to package metadata.
- Reject file globs that attempt to access files outside of the project root.
- Warning before replacing an existing configuration with project initialization.
- Interactive project initialization more clearly describes explict replace format pattern.
- Interactive project initialization now shows recently provided search pattern when addressing issues with a file definition that omitted the replace format pattern.
- Update development status classifier.
- Minimum version of
GitPython
raised to3.1.34
to address a security issue.
- Support for signing commits and tags.
- Support for including a message on a tag.
- Incorrectly adding untracked files when creating a commit.
- BREAKING:
tag_format_pattern
renamed totag_name_format_pattern
.
- Update
typer
to use custom types andAnnotated
declaration style. - Update to
pydantic
2.0. - Use OpenID Connect as a trusted publisher for uploading releases.
--patch
as command line options to display the planned changes as a patch instead of performing any operations.- Multi-line search and replacement patterns.
- Match arbitrary dates when
today
key is used in a search format pattern.
- Display planned changes as a unified diff instead of a custom format.
- Configuration file line endings changed to system default when updating file.
- Incorrectly display of planned change for lines that contained leading whitespace characters.
- Incorrectly display of text containing square brackets (
[
,]
). - Inconsistent display of file and directory paths (absolute vs relative path).
- Crash when format pattern contained an integer key name or no key name.
- Inconsistent colors of displayed text.
- Minor typos in displayed text.
- Ability to limit allowed starting branch.
- Can be run as a module in addition to the entrypoint script.
- Value of
hyper_bump_it.__version__
.
- Use
hyper-bump-it
to manage the version of the project. - Automate the release process of new versions.
- Reorganize internal modules under a single internal sub-module.
- Remove dependency on
semantic-version
.
- Controls related to the interactive confirmation prompt
show_confirm_prompt
in configuration file can explicitly enable (default) or disable the prompt.-y
&--yes
as command line options to disable the prompt.--interactive
as command line options to explicitly enable the prompt.-n
&--no
command line options as aliases for--dry-run
.
- Command line command to initialize a project.
- Name of remote repository to displayed description for push action.
- Support for
rich
v13.x.
- Crash when executing against a repository without any commits. A clear error message is displayed instead.
- Unclear text displayed for proposed execution plan description when compared to text displayed when executing the plan.
First functional release
Initial Release (not functional yet)