Skip to content

Commit 4309cd9

Browse files
authored
docs: add info about manually package version setting to docs (#251)
1 parent 87b8587 commit 4309cd9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,13 @@ In usual cases we use two types of commits:
306306
1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
307307
2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
308308
3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
309+
4. To set release package version manually you need to add `Release-As: <version>` to your commit message e.g.
310+
311+
```bash
312+
git commit -m 'chore: bump release
313+
314+
Release-As: 1.2.3'
315+
```
309316

310317
You can see all information [here](https://www.conventionalcommits.org/en/v1.0.0/).
311318

0 commit comments

Comments
 (0)