doc: update document for --bump

orhun · Jul 30, 2024 · 822805a · 822805a
1 parent 4dc10e2
commit 822805a
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/git-cliff-core/src/config.rs b/git-cliff-core/src/config.rs
@@ -174,7 +174,7 @@ impl Remote {
 	}
 }
 
-/// Verion bump type
+/// Version bump type
 #[derive(Debug, Clone, Copy, Serialize, Deserialize)]
 pub enum BumpType {
 	/// Bump major version

diff --git a/website/docs/usage/args.md b/website/docs/usage/args.md
@@ -14,7 +14,6 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
 -h, --help            Prints help information
 -V, --version         Prints version information
 -v, --verbose...      Increases the logging verbosity
-    --bump            Bumps the version for unreleased changes
     --bumped-version  Prints bumped version for unreleased changes
 -l, --latest          Processes the commits starting from the latest tag
     --current         Processes the commits that belong to the current tag
@@ -28,6 +27,7 @@ git-cliff [FLAGS] [OPTIONS] [--] [RANGE]
 
 ```
 -i, --init [<CONFIG>]              Writes the default configuration file to cliff.toml
+    --bump                         Bumps the version for unreleased changes [default: auto] [possible values: auto, major, minor, patch]
 -c, --config <PATH>                Sets the configuration file [env: GIT_CLIFF_CONFIG=] [default: cliff.toml]
 -w, --workdir <PATH>               Sets the working directory [env: GIT_CLIFF_WORKDIR=]
 -r, --repository <PATH>...         Sets the git repository [env: GIT_CLIFF_REPOSITORY=]

diff --git a/website/docs/usage/bump-version.md b/website/docs/usage/bump-version.md
@@ -42,3 +42,12 @@ A switch from `0` to `1` should indicate a higher API stability level.
 
 You can modify the bumping rules to preserve the zero-based versioning scheme in the
 [configuration file](/docs/configuration/bump).
+
+
+## Bump to specific version type
+
+Optionally you can specify bump type in `--bump`:
+
+```bash
+git cliff --bump [major|minor|patch]
+```