https://github.com/linkdotnet/BuildInformation

A .NET Source Generator that can give you some valuable information about the build.
https://github.com/linkdotnet/BuildInformation

buildinfo dotnet sourcegenerator

Last synced: about 1 month ago
JSON representation

A .NET Source Generator that can give you some valuable information about the build.

• Host: GitHub
• URL: https://github.com/linkdotnet/BuildInformation
• Owner: linkdotnet
• License: mit
• Created: 2023-03-23T21:04:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-24T22:11:28.000Z (about 2 months ago)
• Last Synced: 2024-10-24T22:31:56.497Z (about 2 months ago)
• Topics: buildinfo, dotnet, sourcegenerator
• Language: C#
• Homepage:
• Size: 80.1 KB
• Stars: 15
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• RSCG_Examples - https://github.com/linkdotnet/BuildInformation

README

        
# Incremental Build Information Generator

[![.NET](https://github.com/linkdotnet/BuildInformation/actions/workflows/dotnet.yml/badge.svg)](https://github.com/linkdotnet/BuildInformation/actions/workflows/dotnet.yml)

[![Nuget](https://img.shields.io/nuget/dt/LinkDotNet.BuildInformation)](https://www.nuget.org/packages/LinkDotNet.BuildInformation/)

[![GitHub tag](https://img.shields.io/github/v/tag/linkdotnet/BuildInformation?include_prereleases&logo=github&style=flat-square)](https://github.com/linkdotnet/BuildInformation/releases)

This project provides a simple and easy-to-use C# source generator that embeds build information, such as the build time, platform, warning level, and configuration, directly into your code. By using the `BuildInformation` class, you can quickly access and display these details.

## Features

* Embeds build date (in UTC) in your code

* Embeds platform (AnyCPU, x86, x64, ...) information in your code

* Embeds compiler warning level in your code

* Embeds build configuration (e.g., Debug, Release) in your code

* Embeds the assembly version and assembly file version in your code

* Embeds the target framework moniker in your code

* Embeds the nullability analysis level in your code

* Embeds the deterministic build flag in your code

* Embeds the project path where the generator is running in your code

* Embeds the language and language version (like "C#" and "12.0")

## Configuration

By default the created class is `internal` and is not under any namespace. This can be changed by adding the following to your project file:

```xml

    true

    

```

This will use the root namespace of the project for the generated class. This is especially helpful if the generator is used in multiple projects, that might be visible to each other.

The `AllowProjectDirectoryBuildOutput` property is used to allow the generator to write the project directory into the generated class. This is disabled by default, as it might leak sensitive information.

```xml

    true

    

```

### Git Information

By default, the generator does not include git information. If you want to include the git information, you can add the following to your project file:

```xml

    true

    

```

This will fill the `GitInformation` class with the following properties:

```csharp

Console.WriteLine("Git information:");

Console.WriteLine($"Branch: {GitInformation.Branch}");

Console.WriteLine($"Commit: {GitInformation.Commit}");

Console.WriteLine($"Short commit: {GitInformation.ShortCommit}");

Console.WriteLine($"Nearest tag: {GitInformation.NearestTag}");

Console.WriteLine($"Detailed tag description: {GitInformation.DetailedTagDescription}");

```

This will spawn a `git` process to get the information. 

Therefore, git has to be accessible from the command line. Be advised, that it will increase your build time slightly.

## Usage

To use the `BuildInformation` class in your project, add the NuGet package:

```no-class

dotnet add package LinkDotNet.BuildInformation

```

Here is some code how to use the class:

```csharp

using System;

Console.WriteLine($"Build at: {BuildInformation.BuildAt}");

Console.WriteLine($"Platform: {BuildInformation.Platform}");

Console.WriteLine($"Warning level: {BuildInformation.WarningLevel}");

Console.WriteLine($"Configuration: {BuildInformation.Configuration}");

Console.WriteLine($"Assembly version: {BuildInformation.AssemblyVersion}");

Console.WriteLine($"Assembly file version: {BuildInformation.AssemblyFileVersion}");

Console.WriteLine($"Assembly name: {BuildInformation.AssemblyName}");

Console.WriteLine($"Target framework moniker: {BuildInformation.TargetFrameworkMoniker}");

Console.WriteLine($"Nullability level: {BuildInformation.Nullability}");

Console.WriteLine($"Deterministic build: {BuildInformation.Deterministic}");

Console.WriteLine($"Analysis level: {BuildInformation.AnalysisLevel}");

Console.WriteLine($"Project directory: {BuildInformation.ProjectDirectory}");

Console.WriteLine($"Language: {BuildInformation.Language}");

Console.WriteLine($"Language version: {BuildInformation.LanguageVersion}");

```

You can also hover over the properties to get the currently held value (xmldoc support). An example output could look like this:

```no-class

Build at: 24.03.2024 21:32:17

Platform: AnyCpu

Warning level: 7

Configuration: Debug

Assembly version: 1.0

Assembly file version: 1.2

Assembly name: LinkDotNet.BuildInformation.Sample

Target framework moniker: net7.0

Nullability level: enabled

Deterministic build: true

Analysis level: 7.0

Project directory: /Users/example/repo/this/Sample.csproj

Language: C#

Langugage version: 12.0

```

## Contributing

If you would like to contribute to the project, please submit a pull request or open an issue on the project's GitHub page. We welcome any feedback, bug reports, or feature requests.

## License

This project is licensed under the MIT License.