[New article] Add AmbientMetadata.Build documentation #51192
+349
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evgenyfedorov2
changed the title
evgenyfedorov2
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the Microsoft.Extensions.AmbientMetadata.Build component, which enables .NET applications to capture and access CI/CD build metadata at runtime.
Changes:
- Adds main documentation page explaining build metadata functionality, configuration options, and CI/CD integration
- Includes five code snippet examples demonstrating different usage patterns
- Updates TOC navigation to include the new build metadata documentation
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/navigate/tools-diagnostics/toc.yml | Adds navigation entry for the new build metadata documentation |
| docs/core/enrichment/build-metadata.md | Main documentation file covering installation, configuration, usage, and CI/CD integration |
| docs/core/enrichment/snippets/buildmetadata/* | Complete example showing build metadata setup and usage with logging |
| docs/core/enrichment/snippets/buildmetadata-logging/* | Example demonstrating logging integration with build metadata |
| docs/core/enrichment/snippets/buildmetadata-configure/* | Example showing two-step configuration approach |
| docs/core/enrichment/snippets/buildmetadata-configure-programmatic/* | Example of programmatic configuration |
| docs/core/enrichment/snippets/buildmetadata-access/* | Example of accessing build metadata via dependency injection |
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/ambientmetadata_build_doc
branch
2 times, most recently
from
2247c8f to
8a1ebbf
Compare
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/ambientmetadata_build_doc
branch
from
5a4d2ad to
148ab93
Compare
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/ambientmetadata_build_doc
branch
from
148ab93 to
5d31733
Compare
Member
Author
|
@gewarren please kindly review |
gewarren
approved these changes
Jan 20, 2026
| @@ -0,0 +1,140 @@ | |||
| --- | |||
| title: Build ambient metadata | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Build ambient metadata | |
| title: Ambient metadata about build |
I'm suggesting this wording so as to avoid possible confusion that the article is about building ambient metadata.
| ai-usage: ai-assisted | ||
| --- | ||
|
|
||
| # Build ambient metadata |
Contributor
There was a problem hiding this comment.
Suggested change
| # Build ambient metadata | |
| # Ambient metadata about build |
|
|
||
| ### 2. Use AddBuildMetadata() methods | ||
|
|
||
| You can also configure build metadata using the `AddBuildMetadata()` extension methods. These methods do absolutely the same thing as `UseBuildMetadata()` above, but provide more flexibility if, for instance, you configure Host Configuration and Dependency Injection in different places of your source code. |
Contributor
There was a problem hiding this comment.
Suggested change
| You can also configure build metadata using the `AddBuildMetadata()` extension methods. These methods do absolutely the same thing as `UseBuildMetadata()` above, but provide more flexibility if, for instance, you configure Host Configuration and Dependency Injection in different places of your source code. | |
| You can also configure build metadata using the `AddBuildMetadata()` extension methods. These methods do the same thing as the `UseBuildMetadata()` method described previously, but provide more flexibility if, for instance, you configure Host Configuration and Dependency Injection in different places of your source code. |
Comment on lines
+125
to
+127
| In the example above: | ||
|
|
||
| - We use `appsettings.json` to configure build metadata properties *manually*. This is for demonstration purposes; in a real CI/CD scenario, these values would be captured automatically from respective environment variables, and you don't need to have them in `appsettings.json`. |
Contributor
There was a problem hiding this comment.
Suggested change
| In the example above: | |
| - We use `appsettings.json` to configure build metadata properties *manually*. This is for demonstration purposes; in a real CI/CD scenario, these values would be captured automatically from respective environment variables, and you don't need to have them in `appsettings.json`. | |
| > [!NOTE] | |
| > This example uses `appsettings.json` to configure build metadata properties *manually*. This is for demonstration purposes; in a real CI/CD scenario, these values would be captured automatically from respective environment variables, and you don't need to have them in `appsettings.json`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Provides documentation for a new component Microsoft.Extensions.AmbientMetadata.Build.
Internal previews