From bd60dc3f7488e6c9ee9c250f54f40b41f71a7164 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Thu, 7 Sep 2023 08:34:16 +0200 Subject: [PATCH] docs(README): Clarify which part of the version `autoBump` increments Fixes #20. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5eb8389..9088ee1 100644 --- a/README.md +++ b/README.md @@ -242,8 +242,8 @@ version = semver.version * **noDirtyCheck**: Can be used to ignore all local modifications when calculating the version. * **noAutoBump**: If set only commits matching majorPattern, minorPattern or patchPattern will increase the version. The default behaviour for the plugin is to assume you have begun the work on the next release for any commit you do - after the last release. The version will be incremented by one if not already incremented by **majorPattern, - minorPattern or patchPattern**. + after the last release. The patch level (or pre-release level, if the last release was a pre-release) of the version + will be incremented by one if not already incremented by **majorPattern, minorPattern or patchPattern**. (This option does not apply to the release task.) * **gitDirectory**: The directory where the git repo can be found. * **createReleaseTag**: If a release tag should be created when running the release task. Setting this to false