ThisAssembly.Git
1.5.0-rc.2
Prefix Reserved
See the version list below for details.
dotnet add package ThisAssembly.Git --version 1.5.0-rc.2
NuGet\Install-Package ThisAssembly.Git -Version 1.5.0-rc.2
<PackageReference Include="ThisAssembly.Git" Version="1.5.0-rc.2"> <PrivateAssets>all</PrivateAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference>
paket add ThisAssembly.Git --version 1.5.0-rc.2
#r "nuget: ThisAssembly.Git, 1.5.0-rc.2"
// Install ThisAssembly.Git as a Cake Addin #addin nuget:?package=ThisAssembly.Git&version=1.5.0-rc.2&prerelease // Install ThisAssembly.Git as a Cake Tool #tool nuget:?package=ThisAssembly.Git&version=1.5.0-rc.2&prerelease
This package generates a static ThisAssembly.Git class with constants
for the following Git properties from the current project:
- Commit
- Sha (first 9 chars from Commit)
- Root (normalized to forward slashes)
- Url (if PublishRepositoryUrl=true)
- Branch (from CI environment variables)
This package relies on your project's installed Microsoft.SourceLink.* package reference according to your specific Git-based source control server (such as GitHub, Azure DevOps, BitBucket, etc).
The Branch property is populated from environment variables provided
by the currently supported CI systems: GitHub Actions, Azure DevOps,
AppVeyor, TeamCity, Travis CI, Circle CI, GitLab CI, Buddy, and Jenkins.
Whenever the CI system provides a pull request number, the branch name is
pr[NUMBER], such as pr123. This makes it easy to use it as a semver
metadata label.
Note: by default, the values of these constants are populated during "real" builds (that is, not IDE/design-time builds used to populate intellisense). This is to avoid negatively affecting the editor's performance. This means, however, that the properties will seem to always be empty when inspecting them in the IDE (although never at run-time). If you want to force population of these values for design-time builds, set the
EnableSourceControlManagerQueriesproperty totrue. This property is defined and documented by dotnet/sourcelink.
At the MSBuild level, targets can take a dependency on the provided
InitializeGitInformation target, which sets the equivalent properties
named:
- RepositoryCommit
- RepositorySha
- RepositoryRoot
- RepositoryUrl
- RepositoryBranch
The names of these properties were chosen on purpose to match the properties used by nuget pack and nugetizer to populate the relevant package metadata.
So if you have a GitHub repository, installing these three packages will ensure you have the proper metadata out of the box and the simplest packaging experience possible:
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.SourceLink.GitHub" />
<PackageReference Include="ThisAssembly.Git" />
<PackageReference Include="NuGetizer" />
</ItemGroup>
</Project>
Set the $(ThisAssemblyNamespace) MSBuild property to set the root namespace of the
generated ThisAssembly class. Otherwise, it will be generated in the global namespace.
Sponsors
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- ThisAssembly.Constants (>= 1.5.0-rc.2)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on ThisAssembly.Git:
| Package | Downloads |
|---|---|
|
ThisAssembly
Meta-package that includes all ThisAssembly.* packages. > This project uses SponsorLink to attribute sponsor status (direct, indirect or implicit). For IDE usage, sponsor status is required. > IDE-only warnings will be emitted after a grace period otherwise. Learn more at https://github.com/devlooped#sponsorlink. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on ThisAssembly.Git:
| Repository | Stars |
|---|---|
|
devlooped/ThisAssembly
Exposes project and assembly level information as constants in the ThisAssembly class using source generators powered by Roslyn.
|