LAMBJ-152 Package Version Attribute (#554)

Adds a package version attribute to assemblies called LambdajectionVersion
cythral · Aug 18, 2022 · 105fe3e · 105fe3e
1 parent 92d6a33
commit 105fe3e
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 1 deletion.
diff --git a/.github/releases/v0.10.0-beta2.md b/.github/releases/v0.10.0-beta2.md
@@ -0,0 +1,3 @@
+## Enhancements
+
+- Adds an attribute to each Lambdajection assembly called `LambdajectionVersion` which can be used to retrieve the NuGet Package Version of Lambdajection being used.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -48,4 +48,14 @@
   <ItemGroup>
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Visible="false" />
   </ItemGroup>
+  <ItemGroup>
+    <AdditionalThisAssemblyFields Include="NuGetPackageVersion" String="$(NuGetPackageVersion)" />
+  </ItemGroup>
+  <Target Name="AddNuGetPackageVersionToThisAssembly" DependsOnTargets="GetBuildVersion" BeforeTargets="GenerateAssemblyNBGVVersionInfo" Condition="'$(SkipAddNuGetPackageVersionToThisAssembly)' != 'true'">
+    <ItemGroup>
+      <AssemblyAttribute Include="Lambdajection.Framework.LambdajectionVersion">
+        <_Parameter1>$(NuGetPackageVersion)</_Parameter1>
+      </AssemblyAttribute>
+    </ItemGroup>
+  </Target>
 </Project>
diff --git a/src/Encryption/Encryption.csproj b/src/Encryption/Encryption.csproj
@@ -21,4 +21,4 @@
   <ItemGroup>
     <None Include="build/**" Pack="true" PackagePath="build/" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/src/Framework/LambdajectionVersionAttribute.cs b/src/Framework/LambdajectionVersionAttribute.cs
@@ -0,0 +1,25 @@
+using System;
+
+namespace Lambdajection.Framework
+{
+    /// <summary>
+    /// Attribute for annotating assemblies with the lambdajection package version.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = false, Inherited = false)]
+    public class LambdajectionVersionAttribute : Attribute
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="LambdajectionVersionAttribute" /> class.
+        /// </summary>
+        /// <param name="version">Version of the lambdajection package.</param>
+        public LambdajectionVersionAttribute(string version)
+        {
+            Version = version;
+        }
+
+        /// <summary>
+        /// Gets the version of the Lambdajection package.
+        /// </summary>
+        public string Version { get; }
+    }
+}
diff --git a/src/Generator/Generator.csproj b/src/Generator/Generator.csproj
@@ -11,6 +11,7 @@
     <NoWarn>NU5118;CS8618;NU5128;CS1591;CA1062</NoWarn>
     <BuildOutputTargetFolder>analyzers/dotnet/cs</BuildOutputTargetFolder>
     <DevelopmentDependency>true</DevelopmentDependency>
+    <SkipAddNuGetPackageVersionToThisAssembly>true</SkipAddNuGetPackageVersionToThisAssembly>
     <PackageDescription>Includes the compile-time generator used to generate code needed for Dependency Injection-enabled AWS Lambdas.</PackageDescription>
     <BeforePack>IncludeExtraPackItems</BeforePack>
   </PropertyGroup>

diff --git a/src/Runtime/Runtime.csproj b/src/Runtime/Runtime.csproj
@@ -5,6 +5,7 @@
         <PackageId>Lambdajection.Runtime</PackageId>
         <AssemblyName>$(PackageId)</AssemblyName>
         <NoWarn>NU5128</NoWarn>
+        <SkipAddNuGetPackageVersionToThisAssembly>true</SkipAddNuGetPackageVersionToThisAssembly>
         <PackageDescription>Sets Lambdajection projects up to support custom runtimes.</PackageDescription>
     </PropertyGroup>
 

diff --git a/src/Templates/Templates.csproj b/src/Templates/Templates.csproj
@@ -10,6 +10,7 @@
     <IncludeContentInPack>true</IncludeContentInPack>
     <PackageDescription>Includes templates for creating Lambdajection projects and components.</PackageDescription>
     <BeforePack>CopyTemplates;PrepareTemplates</BeforePack>
+    <SkipAddNuGetPackageVersionToThisAssembly>true</SkipAddNuGetPackageVersionToThisAssembly>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/Tracing/Tracing.csproj b/src/Tracing/Tracing.csproj
@@ -5,6 +5,7 @@
         <AssemblyName>$(PackageId)</AssemblyName>
         <NoWarn>NU5128</NoWarn>
         <IncludeBuildOutput>false</IncludeBuildOutput>
+        <SkipAddNuGetPackageVersionToThisAssembly>true</SkipAddNuGetPackageVersionToThisAssembly>
         <PackageDescription>Adds X-Ray Tracing Support to Lambdajection.</PackageDescription>
     </PropertyGroup>