Skip to content

Commit ab27a91

Browse files
committed
Further updates in GitVersion.yml and in versioning docmentation
1 parent d07787e commit ab27a91

2 files changed

Lines changed: 11 additions & 4 deletions

File tree

GitVersion.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
mode: ContinuousDeployment
1+
# mode: ContinuousDeployment # commented - we leave it to built-in config
22
workflow: GitHubFlow/v1
33
# strategies:
44
# This enables incrementing the patch number on main branch with each commit:
@@ -16,8 +16,8 @@ branches:
1616
is-main-branch: true
1717
develop:
1818
regex: ^develop$
19-
# Add the "beta" + incremented number suffix on develop branch:
20-
label: beta
19+
# Add the "alpha" + incremented number suffix on develop branch:
20+
label: `alpha`
2121
increment: Patch
2222
ignore:
2323
sha: []

README_Development.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,14 @@ Or, to get various version information in JSON:
151151
$gv = dotnet gitversion /output json | ConvertFrom-Json
152152
~~~
153153

154-
When building a C# project from a repository, the GitVersion tool will **add the version-related properties** `Version` (e.g. `1.2.3`), `AssemblyVersion` (e.g. `1.2.0.0`), `FileVersion` (e.g. `1.2.3.0`) and InformationalVersion` (e.g. `1.2.3+Branch.main.Sha.abcdef`) **to** the generated **assembly**. When creating a `NuGet` package with `dotnet pack`, version will be set for the NuGet package.
154+
When building a C# project from a repository, the GitVersion tool will **calculate the version** and **add the version-related properties** `Version` (e.g. `1.2.3`), `AssemblyVersion` (e.g. `1.2.0.0`), `FileVersion` (e.g. `1.2.3.0`) and InformationalVersion` (e.g. `1.2.3+Branch.main.Sha.abcdef`) **to** the generated **assembly**. When creating a `NuGet` package with `dotnet pack`, version will be set for the NuGet package.
155+
156+
You can **override behavior with certain strings in commit messages** ([see configuration doc](https://gitversion.net/docs/reference/configuration)):
157+
158+
* `+semver: major` (or `+semver: breaking`) in commit message will cause bump (increase) in major version
159+
* `+semver: minor` (or `semver: feature`) will cause bump in minor version
160+
* `+semver: patch` or `+semver: fix` will cause bump in patch version
161+
* `+semver: skip` or `+semver: none` will cause that bump that would otherwise be made (automatically) is skipped
155162

156163
> **Warnig**:
157164
> `GitVersion` **does not work when projects / solutions are built in Visual Studio**. This is because `GitVersion` developers only support later .NET LTS and the tool needs .NET Core runtime (see [this Github Discussion](https://github.com/GitTools/GitVersion/discussions/4130)). `Visual Studio` uses stand-alone `MSBuild` that is built *for .NET Framework*, and this cannot be changed (Microsoft only releases MsBuild that is built for .NET Framework).

0 commit comments

Comments
 (0)