cz-nic / bumpversion Goto Github PK

Publish documentation to ReadTheDocs and add GH action for regular update.

--allow-dirty and bumpversion.allow_dirty configuration option should be interpreted as a list of glob patterns. These glob patterns will be ignored when deciding whether to block bumpversion due to dirty git state.

• Make base VCS class
• Add support for mercurial
• Add VCS autodetection

Decide on how much do we want to provide legacy support for people migrationg from bump2version. Our bumpversion is never going to be fully backwards compatible (ini config alone is a blocker for that one), but we can try to get closer if we decide it's worth it.

Ideas:

• Other CLI arguments
• Enumerated parts (e.g. alpha, beta, gamma)

Replacer may print file diffs when verbosity=DEBUG. It would also be a useful feature for --dry-run.

When bumpversion config contains a configuration for a nonexistent file, the program die with a traceback an a somewhat obscure error message:

<Traceback retracted>
pydantic.error_wrappers.ValidationError: 1 validation error for Settings
file -> 0 -> path
  file or directory at path "bumpversion.toml" does not exist (type=value_error.path.not_exists; path=bumpversion.toml)

From the message, it's not clear the problem is in the config file. Most likely applies to all configuration errors.

Add migration guide for bump2version users. It should mainly cover the migration of configuration from .bumpversion.cfg (INI format) to .bumpversion.toml (TOML format).

Add shell autocompletion for some commonly used shells.

Right now, README is not providing any useful information. We should describe why and how this project emerged and add basic install and usage information together with links to more detailed documentation (see #9).

Add bumpversion init <version> [<schema>] [--config-file <config-file>] that initializes bumpversion configuration in given config file (or .bumpversion.toml by default). It may be interactive (asking user questions about schema or files).