bumpversion.cli_options
Shared Click option decorators for bump-my-version commands.
Module-level constants cover options that are identical across every command that uses them. Factory functions are provided for options whose type or default intentionally differs between commands, so divergence cannot happen silently.
config_file_option
python
config_file_option: Callable = config_option('--config-file', envvar='BUMPVERSION_CONFIG_FILE', help='Config file to read most of the variables from.')verbose_option
python
verbose_option: Callable = click.option('-v', '--verbose', count=True, required=False, envvar='BUMPVERSION_VERBOSE', help='Print verbose logging to stderr. Can specify several times for more verbosity.')allow_dirty_option
python
allow_dirty_option: Callable = click.option('--allow-dirty/--no-allow-dirty', default=None, required=False, envvar='BUMPVERSION_ALLOW_DIRTY', help="Don't abort if working directory is dirty, or explicitly abort if dirty.")current_version_option
python
current_version_option: Callable = click.option('--current-version', metavar='VERSION', required=False, envvar='BUMPVERSION_CURRENT_VERSION', help='Version that needs to be updated')new_version_option
python
new_version_option: Callable = click.option('--new-version', metavar='VERSION', required=False, envvar='BUMPVERSION_NEW_VERSION', help='New version that should be in the files')to_option
python
to_option: Callable = click.option('--to', 'to_value', metavar='VALUE', required=False, envvar='BUMPVERSION_TO', help='Set the VERSION_PART to this value instead of incrementing it. Use `--new-version` to replace the whole version.')parse_option
python
parse_option: Callable = click.option('--parse', metavar='REGEX', required=False, envvar='BUMPVERSION_PARSE', help='Regex parsing the version string')serialize_option
python
serialize_option: Callable = click.option('--serialize', metavar='FORMAT', multiple=True, required=False, envvar='BUMPVERSION_SERIALIZE', help='How to format what is parsed back to a version')search_option
python
search_option: Callable = click.option('--search', metavar='SEARCH', required=False, envvar='BUMPVERSION_SEARCH', help='Template for complete string to search')replace_str_option
python
replace_str_option: Callable = click.option('--replace', metavar='REPLACE', required=False, envvar='BUMPVERSION_REPLACE', help='Template for complete string to replace')regex_option
python
regex_option: Callable = click.option('--regex/--no-regex', default=None, envvar='BUMPVERSION_REGEX', help='Treat the search parameter as a regular expression or explicitly do not treat it as a regular expression.')no_configured_files_option
python
no_configured_files_option: Callable = click.option('--no-configured-files', is_flag=True, envvar='BUMPVERSION_NO_CONFIGURED_FILES', help='Only replace the version in files specified on the command line, ignoring the files from the configuration file.')dry_run_option
python
dry_run_option: Callable = click.option('--dry-run', '-n', is_flag=True, envvar='BUMPVERSION_DRY_RUN', help="Don't write any files, just pretend.")ignore_missing_files_option
python
def ignore_missing_files_option(is_flag: bool = False) -> CallableReturn the --ignore-missing-files Click option decorator.
Parameters
is_flag: WhenTrue, returns a simple boolean flag with no--no-counterpart (used by thereplacecommand). WhenFalse(default), returns a tri-state--flag/--no-flagoption whose default isNone, letting the config-file value win when the flag is omitted (used by thebumpcommand).
Returns
- A Click option decorator ready to be applied with
@.
ignore_missing_version_option
python
def ignore_missing_version_option(is_flag: bool = False) -> CallableReturn the --ignore-missing-version Click option decorator.
Parameters
is_flag: WhenTrue, returns a simple boolean flag with no--no-counterpart (used by thereplacecommand). WhenFalse(default), returns a tri-state--flag/--no-flagoption whose default isNone, letting the config-file value win when the flag is omitted (used by thebumpcommand).
Returns
- A Click option decorator ready to be applied with
@.
commit_option
python
commit_option: Callable = click.option('--commit/--no-commit', default=None, envvar='BUMPVERSION_COMMIT', help='Commit to version control')tag_option
python
tag_option: Callable = click.option('--tag/--no-tag', default=None, envvar='BUMPVERSION_TAG', help='Create a tag in version control')push_tag_option
python
push_tag_option: Callable = click.option('--push-tag/--no-push-tag', default=None, envvar='BUMPVERSION_PUSH_TAG', help='Push the tag to the remote after creation (only works with --tag)')sign_tags_option
python
sign_tags_option: Callable = click.option('--sign-tags/--no-sign-tags', default=None, envvar='BUMPVERSION_SIGN_TAGS', help='Sign tags if created')tag_name_option
python
tag_name_option: Callable = click.option('--tag-name', metavar='TAG_NAME', required=False, envvar='BUMPVERSION_TAG_NAME', help='Tag name (only works with --tag)')tag_message_option
python
tag_message_option: Callable = click.option('--tag-message', metavar='TAG_MESSAGE', required=False, envvar='BUMPVERSION_TAG_MESSAGE', help='Tag message')message_option
python
message_option: Callable = click.option('-m', '--message', metavar='COMMIT_MSG', required=False, envvar='BUMPVERSION_MESSAGE', help='Commit message')commit_args_option
python
commit_args_option: Callable = click.option('--commit-args', metavar='COMMIT_ARGS', required=False, envvar='BUMPVERSION_COMMIT_ARGS', help='Extra arguments to commit command')