Skip to content

Commit f416f33

Browse files
authored
Merge pull request #49 from RobSmyth/dev/update-docs
Dev/update docs
2 parents 0af7049 + c666fd8 commit f416f33

File tree

2 files changed

+216
-243
lines changed

2 files changed

+216
-243
lines changed

docs/Usage/Workflow.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,16 @@ Git2SemVer stops walking Git commits when it reaches a (release tags)[xref:relea
3333

3434
An example workflow:
3535

36-
| Step | Resulting build version |
37-
|:-- |:-- |
38-
| Starts at a release (`1.2.3`) marked by tag `v1.2.3`. | 1.2.3 |
39-
| Then a build on without API changes | 1.2.4 as a released version may not be reused. See [Semver spec, item 6](<see href="https://semver.org/#spec-item-6">)
40-
| Then, in a developer branch fixes 2 bugs (e.g: [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) `fix:bug1`). | Remains at 1.2.4 the patch number has already been bumped. Note that [Semver spec, item 6](https://semver.org/#spec-item-6) refers to "fixes" (plural). |
41-
| Then, adds a feature. | 1.3.0 as a feature added since last release. |
42-
| Then, fixes another bug. | Features trump bugs. See [Semver spec, item 7](https://semver.org/#spec-item-7) |
43-
| Then, the work is merged back to a feature branch and then the main branch and this build is released (commit is tagged with used version). | 1.3.0 |
44-
45-
Build versions are .
46-
47-
Worklow git diagram showing build version and, where applicable, [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) git message
48-
elements:
36+
| Step | Action | Version | Explanation |
37+
| :--: |:-- | :--: |:-- |
38+
| &#9312; | Start at a release (`1.2.3`) marked by tag `v1.2.3`. | **1.2.3** | The tag defines this commit as the released version 1.2.3. The versioning release cycle starts from a tagget release. |
39+
| &#9313; | A commit without API changes | 1.2.4 | Bumped as a released version may not be reused. See [Semver spec, item 6](<see href="https://semver.org/#spec-item-6">)
40+
| &#9314; | In a developer branch fix 2 bugs (e.g: [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) `fix:bug1` and `fix:bug2`). | 1.2.4 | No change as the patch number has already been bumped. Note: [Semver spec, item 6](https://semver.org/#spec-item-6) refers to "fixes" (plural). |
41+
| &#9315; | Add a feature `feat:x`. | 1.3.0 | See [Semver item 7](https://semver.org/spec/v2.0.0.html#spec-item-7) |
42+
| &#9316; | Fix another bug `fix:bug3`. | 1.3.0 | See [Semver spec, item 7](https://semver.org/#spec-item-7). It is about changes between releases, not order of changes. |
43+
| &#9317; | Merge the work to a feature branch and then the main branch and this build is released (commit is tagged with used version). | **1.3.0** | A release, the versioning release cycle starts again. |
44+
45+
An example of this worklow's git diagram:
4946
```mermaid
5047
gitGraph
5148
commit id:"1.2.3+100" tag:"v1.2.3"

0 commit comments

Comments
 (0)