Skip to content

Commit

Permalink
patch(automatic-versioning): added prerelease option to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Akalanka47000 authored Feb 18, 2024
1 parent dc40430 commit cb072e1
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions packages/automatic-versioning/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,6 @@ yarn bump-version
npx automatic-versioning --name=<package_name> --recursive
```

## Custom prerelease tag<br/>

```bash
npx automatic-versioning --name=<package_name> --prerelease-tag=<name>
```

## Prerelease branch<br/>

- If this option is specified and the current branch matches it, the versioning will be evaluated as follows <br/>
Expand All @@ -137,6 +131,20 @@ yarn bump-version
npx automatic-versioning --name=<package_name> --prerelease-branch=<branch_name>
```

## Prerelease<br/>

- 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=<package_name> --prerelease
```

## Custom prerelease tag<br/>

```bash
npx automatic-versioning --name=<package_name> --prerelease-tag=<name>
```

## Ignore prefixes<br/>

- 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<br/>
Expand Down

0 comments on commit cb072e1

Please sign in to comment.