|
1 |
| - |
| 1 | + |
2 | 2 |
|
3 |
| -Use convention to derive a SemVer product version from a GitFlow based repository |
| 3 | +Use convention to derive a SemVer product version from a GitFlow/GitHubFlow based repository. To detect that branching model that is in use GitVersion will look for a develop branch. If a develop branch is found GitFlow based version will be appiled |
4 | 4 |
|
5 | 5 | ## Usage:
|
6 | 6 |
|
7 |
| -GitFlowVersion can be used in several ways |
| 7 | +GitVersion can be used in several ways |
8 | 8 |
|
9 | 9 | ### 1. An MSBuild Task
|
10 | 10 |
|
11 |
| -This will wire GitFlowVersion into the MSBuild pipeline of a project and automatically stamp that assembly with the appropriate SemVer information |
| 11 | +This will wire GitVersion into the MSBuild pipeline of a project and automatically stamp that assembly with the appropriate SemVer information |
12 | 12 |
|
13 | 13 | Available on [Nuget](https://www.nuget.org) under [GitFlowVersionTask](https://www.nuget.org/packages/GitFlowVersionTask/)
|
14 | 14 |
|
15 | 15 | Install-Package GitFlowVersionTask
|
16 | 16 |
|
17 | 17 | ### 2. A nuget reference package
|
18 | 18 |
|
19 |
| -This can be used if you want to reference GitFlowVersion and reuse is from .net. |
| 19 | +This can be used if you want to reference GitVersion and reuse is from .net. |
20 | 20 |
|
21 | 21 | Available on [Nuget](https://www.nuget.org) under [GitFlowVersion](https://www.nuget.org/packages/GitFlowVersion/)
|
22 | 22 |
|
@@ -71,7 +71,7 @@ This also have the added benefit of forcing us to follow our branching strategy
|
71 | 71 |
|
72 | 72 | ### Assumptions:
|
73 | 73 |
|
74 |
| -* Using the [GitFlow branching model](http://nvie.com/git-model/) which means that we always have a master and a develop branch. |
| 74 | +* Using the [GitFlow branching model](http://nvie.com/git-model/) which means that we always have a master and a develop branch or the [GitHubFlow branching model](http://scottchacon.com/2011/08/31/github-flow.html) which only has a master branch. |
75 | 75 | * Following [Semantic Versioning](http://semver.org/)
|
76 | 76 | * Planned releases (bumps in major or minor) are done on release branches prefixed with release-. Eg: release-4.1 (or release-4.1.0)
|
77 | 77 | * Hotfixes are prefixed with hotfix- Eg. hotfix-4.0.4
|
|
0 commit comments