Skip to content

Feature: Only generate VersionFileWriter when needed #1

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

Merged
stephanprobst merged 1 commit into from
Jan 2, 2026
Merged

Feature: Only generate VersionFileWriter when needed #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 14 additions & 5 deletions src/SimpleBranchVersioning/AppVersionGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,21 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
provider.GlobalOptions.TryGetValue("build_property.RootNamespace", out string? rootNamespace);
provider.GlobalOptions.TryGetValue("build_property.ProjectDir", out string? projectDir);
provider.GlobalOptions.TryGetValue("build_property.IncludeCommitIdMetadata", out string? includeMetadataStr);
provider.GlobalOptions.TryGetValue("build_property.GenerateVersionFile", out string? generateVersionFileStr);
provider.GlobalOptions.TryGetValue("build_property.SetPackageVersionFromBranch", out string? setPackageVersionStr);

// Parse IncludeCommitIdMetadata (default: true)
bool includeCommitIdMetadata = !string.Equals(includeMetadataStr, "false", StringComparison.OrdinalIgnoreCase);

// Parse GenerateVersionFile (default: false) and SetPackageVersionFromBranch (default: true)
bool generateVersionFile = string.Equals(generateVersionFileStr, "true", StringComparison.OrdinalIgnoreCase);
bool setPackageVersionFromBranch = !string.Equals(setPackageVersionStr, "false", StringComparison.OrdinalIgnoreCase);

// Read git info - prefer using tracked HEAD content, fallback to filesystem
var (branch, commitId) = ParseGitInfo(gitInfo.HeadContent, gitInfo.GitDir)
?? ReadGitInfo(projectDir);

return new BuildProperties(rootNamespace, branch, commitId, includeCommitIdMetadata);
return new BuildProperties(rootNamespace, branch, commitId, includeCommitIdMetadata, generateVersionFile, setPackageVersionFromBranch);
});

// Look for AppVersionConfigAttribute in assembly attributes
Expand Down Expand Up @@ -146,9 +152,12 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
string assemblyAttributesSource = GenerateAssemblyAttributes(versionInfo);
ctx.AddSource("AssemblyVersionInfo.g.cs", SourceText.From(assemblyAttributesSource, Encoding.UTF8));

// Generate version file writer helper (always in fixed namespace for MSBuild to find)
string writerSource = GenerateVersionFileWriter(versionInfo, branch, commitId);
ctx.AddSource("VersionFileWriter.g.cs", SourceText.From(writerSource, Encoding.UTF8));
// Generate version file writer helper only when needed (GenerateVersionFile or SetPackageVersionFromBranch)
if (buildProps.GenerateVersionFile || buildProps.SetPackageVersionFromBranch)
{
string writerSource = GenerateVersionFileWriter(versionInfo, branch, commitId);
ctx.AddSource("VersionFileWriter.g.cs", SourceText.From(writerSource, Encoding.UTF8));
}
});
}

Expand Down Expand Up @@ -395,6 +404,6 @@ private static (string? branch, string? commitId) ReadGitInfo(string? projectDir
}
#pragma warning restore RS1035

private sealed record BuildProperties(string? RootNamespace, string? Branch, string? CommitId, bool IncludeCommitIdMetadata);
private sealed record BuildProperties(string? RootNamespace, string? Branch, string? CommitId, bool IncludeCommitIdMetadata, bool GenerateVersionFile, bool SetPackageVersionFromBranch);
private sealed record AppVersionConfig(string? Namespace, string? ClassName);
}
2 changes: 2 additions & 0 deletions src/SimpleBranchVersioning/build/SimpleBranchVersioning.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
<CompilerVisibleProperty Include="RootNamespace" />
<CompilerVisibleProperty Include="ProjectDir" />
<CompilerVisibleProperty Include="IncludeCommitIdMetadata" />
<CompilerVisibleProperty Include="GenerateVersionFile" />
<CompilerVisibleProperty Include="SetPackageVersionFromBranch" />
</ItemGroup>

<!-- Find the .git directory by walking up from ProjectDir (using forward slashes for cross-platform) -->
Expand Down