diff --git a/packages/automatic-versioning/readme.md b/packages/automatic-versioning/readme.md index f553d9c..b4e3bef 100644 --- a/packages/automatic-versioning/readme.md +++ b/packages/automatic-versioning/readme.md @@ -119,12 +119,6 @@ yarn bump-version npx automatic-versioning --name= --recursive ``` -## Custom prerelease tag
- -```bash - npx automatic-versioning --name= --prerelease-tag= -``` - ## Prerelease branch
- If this option is specified and the current branch matches it, the versioning will be evaluated as follows
@@ -137,6 +131,20 @@ yarn bump-version npx automatic-versioning --name= --prerelease-branch= ``` +## Prerelease
+ +- If this is specified, the versioning will always be one of prerelease, premajor, preminor or prepatch depending on the above commit mapping + +```bash + npx automatic-versioning --name= --prerelease +``` + +## Custom prerelease tag
+ +```bash + npx automatic-versioning --name= --prerelease-tag= +``` + ## Ignore prefixes
- A list of comma separated prefixes to ignore when evaluating the commit message. By default we stop searching for commits once we come across any prefix considered by commitlint as valid prefixes. You can use this option to ignore a few of them if the need arises