Skip to content

fix: set branch prefixes main:5/develop:4 and use Major.Minor.50000.0 as local fallback #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TomProkop wants to merge 2 commits into
base: master
Choose a base branch
from
+22 −11
Open

fix: set branch prefixes main:5/develop:4 and use Major.Minor.50000.0 as local fallback #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce22e99
fix: set branch prefixes main:5/develop:4 and use Major.Minor.50000.0…
TomProkop Jun 23, 2026
fc94034
fix: revert fallback to 0.0.20000.0 — local builds must never reach p…
TomProkop Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ Defaults can be set per project or per folder via `Directory.Build.props` file.
```xml
<Project>
<PropertyGroup>
<GitVersionNumberBranches>master:1;main:1;develop:2;release/*:3</GitVersionNumberBranches>
<GitVersionNumberFallback>0.0.12345.0</GitVersionNumberFallback>
<GitVersionNumberBranches>master:5;main:5;develop:4;release/*:3</GitVersionNumberBranches>
<GitVersionNumberFallback>0.0.20000.0</GitVersionNumberFallback>
</PropertyGroup>
</Project>
```
Expand Down
12 changes: 6 additions & 6 deletions docs/Versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Git-based version number generation is enabled by default. The SDK automatically
|------|--------|---------|
| `Major` | First number from `<Version>` in your project file | `1` |
| `Minor` | Second number from `<Version>` in your project file | `0` |
| `BranchPrefix` | Optional digit (0–5) from branch rules in `GitVersionNumberBranches` | `2` (for develop) |
| `BranchPrefix` | Optional digit (0–5) from branch rules in `GitVersionNumberBranches` | `4` (for develop) |
| `YY` | Last two digits of the latest commit year | `26` |
| `MM` | Month of the latest commit (zero-padded) | `05` |
| `DD` | Day of the latest commit (zero-padded) | `15` |
| `CommitCount` | Number of commits on that day, zero-padded to 3 digits | `003` |

**Example:** `Version=1.0`, branch `develop` (prefix `2`), latest commit on 2026-05-15 with 3 commits that day → **`1.0.22605.15003`**
**Example:** `Version=1.0`, branch `develop` (prefix `4`), latest commit on 2026-05-15 with 3 commits that day → **`1.0.42605.15003`**

The branch prefix allows higher-priority branches (e.g. production) to always have a higher version than lower-priority branches, preventing accidental overwrites when deploying. Maximum prefix value is `5` due to the [build number limitation](https://learn.microsoft.com/en-us/archive/blogs/msbuild/why-are-build-numbers-limited-to-65535) in Windows.

Expand All @@ -29,16 +29,16 @@ Commit counts include commits from all referenced projects (resolved recursively
| Property | Default | Description |
|----------|---------|-------------|
| `GitVersionNumber` | `true` (SDK) / _empty_ (Tasks) | Master switch. Set to `false` to disable Git-based versioning entirely — the project's `Version` property is used as-is. When using the Tasks package directly (without the SDK), this is not set by default. |
| `GitVersionNumberBranches` | `main:1;master:1;develop:2;` (SDK only) | Semicolon-separated branch rules. Each entry is `<branch-name>` or `<branch-name>:<prefix>`. Wildcard patterns are supported (e.g. `feature/*:0`). Defaults are only applied when using the SDK package; the Tasks package alone does not populate this. |
| `GitVersionNumberFallback` | `0.0.20000.0` | Version used when the current branch does not match any rule in `GitVersionNumberBranches`. |
| `GitVersionNumberBranches` | `main:5;master:5;develop:4;` (SDK only) | Semicolon-separated branch rules. Each entry is `<branch-name>` or `<branch-name>:<prefix>`. Wildcard patterns are supported (e.g. `release/*:3`). Defaults are only applied when using the SDK package; the Tasks package alone does not populate this. |
| `GitVersionNumberFallback` | `0.0.20000.0` | Version used when the current branch does not match any rule in `GitVersionNumberBranches`. The `0.0` Major.Minor is intentional — it clearly marks the artifact as a local/untracked build and ensures the environment's version guard will reject it if any real CI artifact is already installed. |

These properties can be set per project in your `.csproj` or shared via `Directory.Build.props`:

```xml
<Project>
<PropertyGroup>
<GitVersionNumberBranches>master:1;main:1;develop:2;release/*:3</GitVersionNumberBranches>
<GitVersionNumberFallback>0.0.12345.0</GitVersionNumberFallback>
<GitVersionNumberBranches>master:5;main:5;develop:4;release/*:3</GitVersionNumberBranches>
<GitVersionNumberFallback>0.0.20000.0</GitVersionNumberFallback>
</PropertyGroup>
</Project>
```
Expand Down
2 changes: 2 additions & 0 deletions src/Dataverse/Tasks/Tasks/GenerateGitVersion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ public override bool Execute()
if (GitVersionNumberFallback == null)
{
Log.LogWarning("GitVersionNumberFallback is null, setting to default.");
// 0.0 Major.Minor intentionally marks this as a local/untracked build.
// The version guard on any real environment will reject it.
GitVersionNumberFallback = "0.0.20000.0";
}

Expand Down
2 changes: 1 addition & 1 deletion src/Sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The `TALXISDevKitDataversePackageName` property can be set explicitly to overrid
| `TALXISDevKitDataversePackageVersion` | _(resolved from SDK install path)_ | Version used in the auto-generated package reference. Defaults to the installed SDK version, extracted from the NuGet cache path (`.../{id}/{version}/Sdk/Sdk.props`), so the referenced `TALXIS.DevKit.Build.Dataverse.*` package matches the SDK version. |
| `TALXISDevKitDataversePackageName` | `$(Base).$(ProjectType)` | Explicit package name; overrides the base + ProjectType combination. |
| `GitVersionNumber` | `true` | Enables Git-based version number generation. Set to `false` to opt out. See [Versioning](/docs/Versioning.md). |
| `GitVersionNumberBranches` | `main:1;master:1;develop:2;` | Default branch rules for Git versioning. See [Versioning](/docs/Versioning.md). |
| `GitVersionNumberBranches` | `main:5;master:5;develop:4;` | Default branch rules for Git versioning. See [Versioning](/docs/Versioning.md). |

## Related Packages

Expand Down
13 changes: 11 additions & 2 deletions src/Sdk/Sdk/Sdk.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,18 @@
</PropertyGroup>

<!-- Default branch rules for Git versioning. Evaluated after the project file
so that GitVersionNumber=false in the csproj correctly prevents population. -->
so that GitVersionNumber=false in the csproj correctly prevents population.

Priority ladder (higher prefix = higher version = wins on deployment):
develop : 4 (integration CI)
main/master : 5 (production – always wins)

Untracked/local builds fall back to 0.0.20000.0 — the 0.0 Major.Minor
is intentional: it makes local artifacts clearly distinguishable from CI
builds and prevents them from ever being imported over a real CI artifact
(the environment's version guard rejects any lower-version import). -->
<PropertyGroup>
<GitVersionNumberBranches Condition="'$(GitVersionNumberBranches)' == '' and '$(GitVersionNumber)' == 'true'">main:1;master:1;develop:2;</GitVersionNumberBranches>
<GitVersionNumberBranches Condition="'$(GitVersionNumberBranches)' == '' and '$(GitVersionNumber)' == 'true'">main:5;master:5;develop:4;</GitVersionNumberBranches>
</PropertyGroup>

<ItemGroup Condition="'$(TALXISDevKitDataversePackageName)' != ''">
Expand Down