Add AmbientMetadata.Build component #6623

evgenyfedorov2 · 2025-07-17T08:21:41Z

Adding a brand new component - Build metadata, which automatically grabs build information from the CI/CD pipelines, deserializes it into a strong type BuildMetadata and registers it in Dependency Injection container as IOptions<BuildMetadata>.
The component uses source generation to collect build information and immediately express it via C# code.

Initially, only GitHub Actions and Azure DevOps are supported

Microsoft Reviewers: Open in CodeFlow

dariusclay · 2025-07-17T08:25:25Z

I love porting until I realize my commit history is lost. 🤣

src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/BuildMetadata.cs

slang25 · 2025-07-17T09:19:32Z

src/Generators/Microsoft.Gen.BuildMetadata/Model.cs

+    // Azure DevOps environment variables: https://learn.microsoft.com/azure/devops/pipelines/build/variables#build-variables-devops-services
+    internal static string? AzureBuildId = Environment.GetEnvironmentVariable("Build_BuildId");
+    internal static string? AzureBuildNumber = Environment.GetEnvironmentVariable("Build_BuildNumber");
+    internal static string? AzureSourceBranchName = Environment.GetEnvironmentVariable("Build_SourceBranchName");


Couldn't this alternatively be fetched by the InitializeSourceControlInformation and related targets in MSBuild that are used for SourceLink, that way this would work for local builds as well as CI.

updated to fetch data from MSBuild properties, which by default are initialized from environment variables.

…hub.com/evgenyfedorov2/dotnet-extensions into users/evgenyfedorov2/add_build_metadata

KalleOlaviNiemitalo

What's the purpose of the empty src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/Microsoft.Extensions.AmbientMetadata.Build.json file?

src/Generators/Microsoft.Gen.BuildMetadata/Emitter.cs

src/Generators/Microsoft.Gen.BuildMetadata/BuildMetadataGenerator.cs

src/Generators/Microsoft.Gen.BuildMetadata/Microsoft.Gen.BuildMetadata.csproj

evgenyfedorov2 · 2025-09-12T13:58:23Z

What's the purpose of the empty src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/Microsoft.Extensions.AmbientMetadata.Build.json file?

Removed :)

Copilot

Pull Request Overview

This PR introduces a new AmbientMetadata.Build component that provides automatic build metadata collection from CI/CD pipelines. The component uses source generation to extract build information at compile time and register it in the dependency injection container as IOptions.

Key changes:

New BuildMetadata class with properties for build ID, number, branch name, and source version
Source generator that reads MSBuild properties and generates configuration extensions
Support for both Azure DevOps and GitHub Actions CI environments

Reviewed Changes

Copilot reviewed 20 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/BuildMetadata.cs	Defines the core data model for build metadata
src/Generators/Microsoft.Gen.BuildMetadata/BuildMetadataGenerator.cs	Main source generator that creates build metadata extensions
src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/BuildMetadataServiceCollectionExtensions.cs	Extension methods for registering BuildMetadata in DI container
src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/buildTransitive/Microsoft.Extensions.AmbientMetadata.Build.props	MSBuild properties file that maps CI environment variables to build properties
test/Libraries/Microsoft.Extensions.AmbientMetadata.Build.Tests/	Unit tests for the build metadata functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...s/Microsoft.Extensions.AmbientMetadata.Build.Tests/ConfigurationBindingQuirkBehaviorTests.cs

…s/ConfigurationBindingQuirkBehaviorTests.cs Co-authored-by: Copilot <[email protected]>

Copilot

Pull Request Overview

Copilot reviewed 20 out of 24 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

...sions.AmbientMetadata.Build/buildTransitive/Microsoft.Extensions.AmbientMetadata.Build.props

test/Generators/Microsoft.Gen.BuildMetadata/Unit/GeneratorTests.cs

Copilot

Pull Request Overview

Copilot reviewed 20 out of 24 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/Generators/Microsoft.Gen.BuildMetadata/AnalyzerConfigOptionsExtensions.cs

test/Generators/Microsoft.Gen.BuildMetadata/Unit/GeneratorTests.cs

jaredpar · 2025-09-24T17:05:16Z

@333fred, @jjonescz, @JoeRobich PTAL

333fred · 2025-09-24T20:20:37Z

src/Generators/Microsoft.Gen.BuildMetadata/Microsoft.Gen.BuildMetadata.csproj

+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" PrivateAssets="all" />


Generators should not reference this package; if you accidentally depend on anything from the workspaces layer, you will throw during dotnet build.

Suggested change

<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" PrivateAssets="all" />

<PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />

333fred · 2025-09-24T20:23:24Z

src/Generators/Microsoft.Gen.BuildMetadata/BuildMetadataGenerator.cs

+    private readonly struct BuildMetadata
+    {
+        public string? BuildId { get; }
+
+        public string? BuildNumber { get; }
+
+        public string? SourceBranchName { get; }
+
+        public string? SourceVersion { get; }
+
+        public BuildMetadata(string? buildId, string? buildNumber, string? sourceBranchName, string? sourceVersion)
+        {
+            BuildId = buildId;
+            BuildNumber = buildNumber;
+            SourceBranchName = sourceBranchName;
+            SourceVersion = sourceVersion;
+        }
+    }


Consider just making this a record struct. It provides a more efficient equality definition and is simpler to declare.

Suggested change

private readonly struct BuildMetadata

{

public string? BuildId { get; }

public string? BuildNumber { get; }

public string? SourceBranchName { get; }

public string? SourceVersion { get; }

public BuildMetadata(string? buildId, string? buildNumber, string? sourceBranchName, string? sourceVersion)

{

BuildId = buildId;

BuildNumber = buildNumber;

SourceBranchName = sourceBranchName;

SourceVersion = sourceVersion;

}

}

private readonly record struct BuildMetadata(string? BuildId, string? BuildNumber, string? SourceBranchName, string? SourceVersion);

333fred · 2025-09-24T20:27:41Z

src/Generators/Microsoft.Gen.BuildMetadata/Emitter.cs

+        OutLn("private sealed class BuildMetadataSource : IConfigurationSource");
+        OutOpenBrace();
+            OutLn("public string SectionName { get; }");
+            OutLn();
+
+            OutLn("public BuildMetadataSource(string sectionName)");
+            OutOpenBrace();
+                OutNullGuards(checkBuilder: false);
+                OutLn("SectionName = sectionName;");
+            OutCloseBrace();
+            OutLn();
+
+            OutLn("public IConfigurationProvider Build(IConfigurationBuilder builder)");
+            OutOpenBrace();
+                OutLn("return new MemoryConfigurationProvider(new MemoryConfigurationSource())");
+                OutOpenBrace();
+                    OutLn($$"""{ $"{SectionName}:buildid", "{{_buildId}}" },""");
+                    OutLn($$"""{ $"{SectionName}:buildnumber", "{{_buildNumber}}" },""");
+                    OutLn($$"""{ $"{SectionName}:sourcebranchname", "{{_sourceBranchName}}" },""");
+                    OutLn($$"""{ $"{SectionName}:sourceversion", "{{_sourceVersion}}" },""");
+                OutCloseBraceWithExtra(";");
+            OutCloseBrace();
+        OutCloseBrace();


Consider putting actual braces in your code; it will allow you to get rid of the formatting suppression and make the formatter generally work with you.

Suggested change

OutLn("private sealed class BuildMetadataSource : IConfigurationSource");

OutOpenBrace();

OutLn("public string SectionName { get; }");

OutLn();

OutLn("public BuildMetadataSource(string sectionName)");

OutOpenBrace();

OutNullGuards(checkBuilder: false);

OutLn("SectionName = sectionName;");

OutCloseBrace();

OutLn();

OutLn("public IConfigurationProvider Build(IConfigurationBuilder builder)");

OutOpenBrace();

OutLn("return new MemoryConfigurationProvider(new MemoryConfigurationSource())");

OutOpenBrace();

OutLn($$"""{ $"{SectionName}:buildid", "{{_buildId}}" },""");

OutLn($$"""{ $"{SectionName}:buildnumber", "{{_buildNumber}}" },""");

OutLn($$"""{ $"{SectionName}:sourcebranchname", "{{_sourceBranchName}}" },""");

OutLn($$"""{ $"{SectionName}:sourceversion", "{{_sourceVersion}}" },""");

OutCloseBraceWithExtra(";");

OutCloseBrace();

OutCloseBrace();

OutLn("private sealed class BuildMetadataSource : IConfigurationSource");

OutOpenBrace();

{

OutLn("public string SectionName { get; }");

OutLn();

OutLn("public BuildMetadataSource(string sectionName)");

OutOpenBrace();

{

OutNullGuards(checkBuilder: false);

OutLn("SectionName = sectionName;");

}

OutCloseBrace();

OutLn();

OutLn("public IConfigurationProvider Build(IConfigurationBuilder builder)");

OutOpenBrace();

{

OutLn("return new MemoryConfigurationProvider(new MemoryConfigurationSource())");

OutOpenBrace();

{

OutLn($$"""{ $"{SectionName}:buildid", "{{_buildId}}" },""");

OutLn($$"""{ $"{SectionName}:buildnumber", "{{_buildNumber}}" },""");

OutLn($$"""{ $"{SectionName}:sourcebranchname", "{{_sourceBranchName}}" },""");

OutLn($$"""{ $"{SectionName}:sourceversion", "{{_sourceVersion}}" },""");

}

OutCloseBraceWithExtra(";");

}

OutCloseBrace();

}

OutCloseBrace();

333fred · 2025-09-24T20:30:00Z

src/Generators/Microsoft.Gen.BuildMetadata/Emitter.cs

+    private void GenerateBuildMetadataSource()
+    {
+        OutGeneratedCodeAttribute();
+        OutLn("[EditorBrowsable(EditorBrowsableState.Never)]");


Consider using global::Fully.Prefixed.Types, rather than relying on usings. You don't know what global usings the user will have set up, and names they may have defined could potentially conflict with yours. Smaller generators can get away without fully-specifying, but for reliability we suggest that larger generators always use the fully-qualified form.

333fred · 2025-09-24T20:32:11Z

src/Generators/Microsoft.Gen.BuildMetadata/Emitter.cs

+
+namespace Microsoft.Gen.BuildMetadata;
+
+internal sealed class Emitter : EmitterBase


GeneratorUtilies.cs is not in this review, so I can't comment on it, but it links an issue that was closed in 2021. Consider removing the link and using a complete reason.

333fred · 2025-09-24T20:34:55Z

test/Generators/Microsoft.Gen.BuildMetadata/Unit/GeneratorTests.cs

+        string source,
+        TestAnalyzerConfigOptionsProvider optionsProvider)
+    {
+        // Create a test project and compilation


Consider using Microsoft.CodeAnalysis.CSharp.SourceGenerators.Testing, rather than a homegrown framework. Specifically, RoslynTestUtils appears to have a number of anti-patterns, such as getting assemblies by using typeof(object).Location. The official testing library takes care of a lot of this for you, getting the real assemblies for different .NET versions.

initial commit

812bd52

github-actions bot added the area-telemetry label Jul 17, 2025

dotnet-policy-service bot assigned evgenyfedorov2 Jul 17, 2025

evgenyfedorov2 added area-configuration and removed area-telemetry labels Jul 17, 2025

Fix warnings

3e81442

slang25 reviewed Jul 17, 2025

View reviewed changes

src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/BuildMetadata.cs Outdated Show resolved Hide resolved

slang25 reviewed Jul 17, 2025

View reviewed changes

evgenyfedorov2 added 2 commits July 17, 2025 11:40

Merge branch 'main' into users/evgenyfedorov2/add_build_metadata

59cc400

Fix class name

c89c277

evgenyfedorov2 mentioned this pull request Jul 18, 2025

[API Proposal]: Introduce Build ambient metadata #6628

Open

evgenyfedorov2 and others added 2 commits July 18, 2025 11:16

Merge branch 'users/evgenyfedorov2/add_build_metadata' of https://git…

524df26

…hub.com/evgenyfedorov2/dotnet-extensions into users/evgenyfedorov2/add_build_metadata

Remove obsolete code

4172707

KalleOlaviNiemitalo reviewed Sep 9, 2025

View reviewed changes

evgenyfedorov2 added 4 commits September 11, 2025 12:03

Remove BuildDateTime

e0b0fc8

Remove empty json file

5f441d4

Use MSBuild properties

4d5a8ff

fix tests

82c2dce

Working version

047920f

evgenyfedorov2 marked this pull request as ready for review September 16, 2025 13:06

evgenyfedorov2 requested a review from a team as a code owner September 16, 2025 13:06

Copilot AI review requested due to automatic review settings September 16, 2025 13:06

Copilot AI reviewed Sep 16, 2025

View reviewed changes

...s/Microsoft.Extensions.AmbientMetadata.Build.Tests/ConfigurationBindingQuirkBehaviorTests.cs Outdated Show resolved Hide resolved

...s/Microsoft.Extensions.AmbientMetadata.Build.Tests/ConfigurationBindingQuirkBehaviorTests.cs Outdated Show resolved Hide resolved

evgenyfedorov2 requested review from jaredpar and dariusclay September 16, 2025 13:09

Update test/Libraries/Microsoft.Extensions.AmbientMetadata.Build.Test…

e90c5b9

…s/ConfigurationBindingQuirkBehaviorTests.cs Co-authored-by: Copilot <[email protected]>

evgenyfedorov2 requested a review from Copilot September 16, 2025 13:10

Copilot AI reviewed Sep 16, 2025

View reviewed changes

...sions.AmbientMetadata.Build/buildTransitive/Microsoft.Extensions.AmbientMetadata.Build.props Outdated Show resolved Hide resolved

test/Generators/Microsoft.Gen.BuildMetadata/Unit/GeneratorTests.cs Show resolved Hide resolved

PR Comments

7ed6565

evgenyfedorov2 force-pushed the users/evgenyfedorov2/add_build_metadata branch from 9e1009a to 7ed6565 Compare September 16, 2025 13:15

evgenyfedorov2 requested a review from Copilot September 16, 2025 13:15

Copilot AI reviewed Sep 16, 2025

View reviewed changes

src/Generators/Microsoft.Gen.BuildMetadata/AnalyzerConfigOptionsExtensions.cs Show resolved Hide resolved

test/Generators/Microsoft.Gen.BuildMetadata/Unit/GeneratorTests.cs Show resolved Hide resolved

333fred reviewed Sep 24, 2025

View reviewed changes

	<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" PrivateAssets="all" />
	<PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />


		namespace Microsoft.Gen.BuildMetadata;

		internal sealed class Emitter : EmitterBase

Add AmbientMetadata.Build component #6623

Are you sure you want to change the base?

Add AmbientMetadata.Build component #6623

Uh oh!

Conversation

evgenyfedorov2 commented Jul 17, 2025 • edited by dotnet-policy-service bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Microsoft Reviewers: Open in CodeFlow

Uh oh!

dariusclay commented Jul 17, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KalleOlaviNiemitalo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

evgenyfedorov2 commented Sep 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

jaredpar commented Sep 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

evgenyfedorov2 commented Jul 17, 2025 •

edited by dotnet-policy-service bot

Loading