bump-my-version Command line interface.
Classes¶
Functions¶
bump(
args: list,
config_file: Optional[str],
verbose: int,
allow_dirty: Optional[bool],
current_version: Optional[str],
new_version: Optional[str],
parse: Optional[str],
serialize: Optional[List[str]],
search: Optional[str],
replace: Optional[str],
regex: Optional[bool],
no_configured_files: bool,
ignore_missing_files: bool,
ignore_missing_version: bool,
dry_run: bool,
commit: Optional[bool],
tag: Optional[bool],
sign_tags: Optional[bool],
tag_name: Optional[str],
tag_message: Optional[str],
message: Optional[str],
commit_args: Optional[str],
) -> None
Change the version.
ARGS may contain any of the following:
VERSION_PART is the part of the version to increase, e.g. minor.
Valid values include those given in the --serialize / --parse option.
FILES are additional file(s) to modify.
If you want to rewrite only files specified on the command line, use with the
--no-configured-files option.
replace(
files: list,
config_file: Optional[str],
verbose: int,
allow_dirty: Optional[bool],
current_version: Optional[str],
new_version: Optional[str],
parse: Optional[str],
serialize: Optional[List[str]],
search: Optional[str],
replace: Optional[str],
regex: bool,
no_configured_files: bool,
ignore_missing_version: bool,
ignore_missing_files: bool,
dry_run: bool,
) -> None
Replace the version in files.
FILES are additional file(s) to modify.
If you want to rewrite only files specified on the command line, use with the
--no-configured-files option.
sample_config(prompt: bool, destination: str) -> None
Print a sample configuration file.
show(
args: List[str],
config_file: Optional[str],
format_: str,
increment: Optional[str],
current_version: Optional[str],
) -> None
Show current configuration information.
ARGS may contain one or more configuration attributes. For example:
bump-my-version show current_version
bump-my-version show files.0.filename
bump-my-version show scm_info.branch_name
bump-my-version show current_version scm_info.distance_to_latest_tag
show_bump(
version: str,
config_file: Optional[str],
ascii: bool,
verbose: int,
) -> None
Show the possible versions resulting from the bump subcommand.