technofab/bumpver
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/bumpver.git synced 2025-12-18 17:23:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Manuel Barkhau 2020-10-20 22:35:24 +00:00
parent ae3ebb7624
commit def43b9e3f
2 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -510,11 +510,11 @@ Options:
-v, --verbose Control log level. -vv for debug level. -v, --verbose Control log level. -vv for debug level.
Commands: Commands:
update Increment the current version string and update project files.
grep Search file(s) for a version pattern. grep Search file(s) for a version pattern.
init Initialize [bumpver] configuration. init Initialize [bumpver] configuration.
show Show current version of your project. show Show current version of your project.
test Increment a version number for demo purposes. test Increment a version number for demo purposes.
update Update project files with the incremented version string.
``` ```
<!-- END bumpver --help --> <!-- END bumpver --help -->
@ -525,30 +525,31 @@ Commands:
$ bumpver update --help $ bumpver update --help
Usage: bumpver update [OPTIONS] Usage: bumpver update [OPTIONS]
Increment the current version string and update project files. Update project files with the incremented version string.
Options: Options:
-v, --verbose Control log level. -vv for debug level.
-f, --fetch / -n, --no-fetch Sync tags from remote origin.
-d, --dry Display diff of changes, don't rewrite files. -d, --dry Display diff of changes, don't rewrite files.
-f, --fetch / -n, --no-fetch Sync tags from remote origin.
-v, --verbose Control log level. -vv for debug level.
--allow-dirty Commit even when working directory is has --allow-dirty Commit even when working directory is has
uncomitted changes. (WARNING: The commit will uncomitted changes. (WARNING: The commit will
still be aborted if there are uncomitted to still be aborted if there are uncomitted to
files with version strings. files with version strings.
--major Increment major component. --set-version <VERSION> Set version explicitly.
-m, --minor Increment minor component. --date <ISODATE> Set explicit date in format YYYY-0M-0D (e.g.
-p, --patch Increment patch component. 2020-10-20).
-t, --tag <NAME> Override release tag of current_version. Valid
options are: alpha, beta, rc, post, final.
--pin-date Leave date components unchanged.
--tag-num Increment release tag number (rc1, rc2, --tag-num Increment release tag number (rc1, rc2,
rc3..). rc3..).
--pin-date Leave date components unchanged. -t, --tag <NAME> Override release tag of current_version. Valid
--date <ISODATE> Set explicit date in format YYYY-0M-0D (e.g. options are: alpha, beta, rc, post, final.
2020-10-16).
-p, --patch Increment patch component.
-m, --minor Increment minor component.
--major Increment major component.
--help Show this message and exit. --help Show this message and exit.
``` ```

2
src/bumpver/cli.py
View file

@ -607,7 +607,7 @@ def _try_update(
@verbose_option @verbose_option
@dry_option @dry_option
def init(verbose: int = 0, dry: bool = False) -> None: def init(verbose: int = 0, dry: bool = False) -> None:
"""Initialize [calver] configuration.""" """Initialize [bumpver] configuration."""
_configure_logging(verbose=max(_VERBOSE, verbose)) _configure_logging(verbose=max(_VERBOSE, verbose))
ctx, cfg = config.init(project_path=".", cfg_missing_ok=True) ctx, cfg = config.init(project_path=".", cfg_missing_ok=True)