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

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

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

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

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

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

Copilot

Pull Request Overview

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

_{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

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

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

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

jjonescz · 2025-09-26T09:22:43Z

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

+        context.AddSource("BuildMetadataExtensions.g.cs", SourceText.From(result, Encoding.UTF8));
+    }
+
+    private readonly record struct BuildMetadata(string? BuildId, string? BuildNumber, string? SourceBranchName, string? SourceVersion);


Should "IsAzureDevOps" flag be also stored?

As of today it is used for deciding azure devops vs. github actions, nothing else. It is not used as a public property either. So I don't see why we should store it?

If I understand correctly, this source generator is about embedding metadata like build ID into the compilation, right? But you only embed "build ID", and then when I look into the DLL, I will see an attribute which tells me the "build ID" but I won't know if it was actually built on GitHub Actions or AzDo. (I guess I should know where my product is built, but maybe it can be built on either of these...) So I was just wondering if that would also be a useful piece of information to embed. But I may be completely misunderstanding the big picture here :)

Also I guess IsAzDo + BuildId is still not a unique identifier (to be able to unambiguously find the original build), one would also need to know the azdo org etc. So that's probably not the goal and you can ignore me.

but I won't know if it was actually built on GitHub Actions or AzDo
this is intended, this component tries to abstract away that stuff. In theory, we can be adding support of some other CI system in future

Also I guess IsAzDo + BuildId is still not a unique identifier
This is not the goal either. If users find it useful, we will consider adding it, but right now we try to limit the public API surface and make the component simple - it just gives users build information.

jjonescz · 2025-09-26T09:23:50Z

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

+
+namespace Microsoft.Gen.BuildMetadata;
+
+[SuppressMessage("Format", "S1199", Justification = "For better visualization of how the generated code will look like.")]


Is this suppression still needed? (I'm not sure what S1199 is about actually)

It is a Sonar rule https://sonarqube.inria.fr/sonarqube/coding_rules?open=csharpsquid%3AS1199&rule_key=csharpsquid%3AS1199, kicks in because we have extra curly braces

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

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

jjonescz · 2025-09-30T16:03:21Z

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

        // Create the generator driver with the options provider
        var driver = Microsoft.CodeAnalysis.CSharp.CSharpGeneratorDriver.Create(
            generators: new[] { new BuildMetadataGenerator().AsSourceGenerator() },
+            parseOptions: CSharpParseOptions.Default.WithLanguageVersion(LanguageVersion.Preview),


If the source generators are supposed to run across various user configurations, they should support different language versions. I'm not sure if that's something worth testing though.

333fred · 2025-09-30T16:25:11Z

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

            optionsProvider: optionsProvider);

-        var result = driver.RunGenerators(comp!);
+        var result = driver.RunGeneratorsAndUpdateCompilation(comp!, out var outputCompilation, out var diagnostics);


diagnostics is just the diagnostics your generator would have reported itself; the global::System.string issue would not have been caught by this. Please verify that compilation.GetDiagnostics either returns nothing, or the set of diagnostics you're expecting.

eduherminio · 2025-10-01T10:34:33Z

src/Libraries/Microsoft.Extensions.AmbientMetadata.Build/README.md

+# About This Project
+
+This ambient metadata provider provides Build information at runtime.
+See https://learn.microsoft.com/azure/devops/pipelines/build/variables for details.


Should we also mention https://docs.github.com/en/actions/reference/variables-reference#default-environment-variables here?

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 dariusclay and jaredpar 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 Outdated Show resolved Hide resolved

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

333fred reviewed Sep 24, 2025

View reviewed changes

evgenyfedorov2 added 4 commits September 26, 2025 10:42

PR Comments

03c247d

Merge branch 'main' into users/evgenyfedorov2/add_build_metadata

3c07154

PR comments

520b267

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

9dd9936

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

This was referenced Sep 26, 2025

Remove warning suppression in GeneratorUtilities.cs #6856

Open

Onboard to Microsoft.CodeAnalysis.CSharp.SourceGenerators.Testing #6857

Open

evgenyfedorov2 requested review from 333fred and Copilot September 26, 2025 08:54

Copilot AI reviewed Sep 26, 2025

View reviewed changes

jjonescz approved these changes Sep 26, 2025

View reviewed changes

PR comments

c7a1f22

jjonescz approved these changes Sep 30, 2025

View reviewed changes

333fred reviewed Sep 30, 2025

View reviewed changes

eduherminio reviewed Oct 1, 2025

View reviewed changes


		namespace Microsoft.Gen.BuildMetadata;

		[SuppressMessage("Format", "S1199", Justification = "For better visualization of how the generated code will look like.")]

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!

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jjonescz Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

evgenyfedorov2 commented Jul 17, 2025 •

edited by dotnet-policy-service bot

Loading

jjonescz Sep 30, 2025 •

edited

Loading