docs: updating documentation
This commit is contained in:
parent
dfcc08e78f
commit
0b38b8b1d3
1 changed files with 21 additions and 11 deletions
32
README.md
32
README.md
|
@ -6,18 +6,28 @@ This utility does one thing only, calculate the [semantic version]() from Git co
|
||||||
|
|
||||||
For example, the version of "Package1" will be 1.2.4 and "Package2" will be 1.3.0 from the following commits:
|
For example, the version of "Package1" will be 1.2.4 and "Package2" will be 1.3.0 from the following commits:
|
||||||
|
|
||||||
- `fix: fixing package1`
|
```
|
||||||
- `src/package1/file1.txt`
|
$ git log --name-only # filter out unimportant bits
|
||||||
- `feat: fixing package2`
|
fix: fixing package1
|
||||||
- `src/package2/file2.txt`
|
|
||||||
- `fix: sweeping change`
|
|
||||||
- `src/package1/file.txt`
|
|
||||||
- `src/package2/file.txt`
|
|
||||||
- `feat: current version` [tagged "Package1-1.2.3", "Package2-1.2.3"]
|
|
||||||
- `src/package1/file.txt`
|
|
||||||
- `src/package2/file.txt`
|
|
||||||
|
|
||||||
In the above example, the second commit is ignored while calculating the "Package1" commits while the first one is ignored while calculating "Package2".
|
src/package1/file1.txt
|
||||||
|
|
||||||
|
feat: fixing package2
|
||||||
|
|
||||||
|
src/package2/file2.txt
|
||||||
|
|
||||||
|
fix: sweeping change
|
||||||
|
|
||||||
|
src/package1/file.txt
|
||||||
|
src/package2/file.txt
|
||||||
|
|
||||||
|
feat: current version # tagged "Package1-1.2.3" and "Package2-1.2.3"
|
||||||
|
|
||||||
|
src/package1/file.txt
|
||||||
|
src/package2/file.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
In the above example, the second commit is ignored while calculating the "Package1" commits which will have a new version of "1.3.0" because of the "feat" commit. While calculating "Package2", the version will be "1.2.4" because of the "fix" in the second commit because the first is ignored.
|
||||||
|
|
||||||
If a version cannot be found, this will use `0.0.1`.
|
If a version cannot be found, this will use `0.0.1`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue