Skip to content
Snippets Groups Projects
Verified Commit a30ca8b2 authored by Volker Schukai's avatar Volker Schukai :alien:
Browse files

chore: doc

parent 54aa2736
No related branches found
No related tags found
No related merge requests found
......@@ -58,6 +58,32 @@ With the command build the current build date can be output.
version build
```
**Auto**
The 'auto' feature allows the tool to automatically determine the next version
based on the project's git commit history since the last tag.
It uses semantic commit messages to determine the type of version bump.
If a commit message starts with "feat:", it will trigger a minor version bump.
If a commit message starts with "fix:" or if it includes "BREAKING CHANGE",
it will trigger a patch or a major version bump respectively.
Here is how you can use the 'auto' feature:
```bash
version auto --git
```
Without the '--git' flag, the tool will use the last tag in the git history
as the starting point for the version calculation. The result will be printed
to stdout or written to a file if the '--path' flag is provided.
It is important to note that this feature requires that your commit messages
follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/)
message format.
**Makefile**
```makefile
......
......@@ -5,7 +5,7 @@
"meta": {
"created": "2015-01-01T00:00:00.000Z",
"updated": "2015-01-01T00:00:00.000Z",
"version": "1.0.22"
"version": "1.4.0"
}
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment