feat: strong names for published assemblies (#586)

delatrie · web-flow · commit ad360239809c · 2025-10-07T16:24:03.000+07:00
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -13,8 +13,8 @@ permissions:
   contents: read
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  publish:
+    runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
 
@@ -26,32 +26,50 @@ jobs:
             6.0.x
 
       - name: 'Restore packages'
+        shell: pwsh
         run: |
           dotnet restore ${{ env.SOLUTION_PATH }}
 
-      # Use AspectInjector 2.8.2 which, unlike 2.8.1, correctly sets PdbChecksum
-      # The only reason we're still referencing 2.8.1 from projects is that
-      # 2.8.2 doesn't work well on Mac OS ARM
+      - name: 'Resolve sn.exe location'
+        id: find-snexe
+        shell: pwsh
+        run: |
+          $SnExeLocation = ./build/findvstool.ps1 -ToolName 'sn.exe'
+          Write-Host "Found '$SnExeLocation'"
+          "path=$SnExeLocation" >> $Env:GITHUB_OUTPUT
+
       - name: 'Build project using dotnet'
+        shell: pwsh
+        run: |
+          dotnet build ${{ env.SOLUTION_PATH }} `
+            --no-restore `
+            --configuration ${{ env.BUILD_CONFIGURATION }} `
+            -p:ContinuousIntegrationBuild=true `
+            "-p:Allure_SnExePath=${{ steps.find-snexe.outputs.path }}"
+
+      - name: Verify assembly strong names
+        shell: pwsh
         run: |
-          dotnet build ${{ env.SOLUTION_PATH }}\
-            --no-restore\
-            --configuration ${{ env.BUILD_CONFIGURATION }}\
-            -p:ContinuousIntegrationBuild=true\
-            "-p:AspectInjector_Location=${{ github.workspace }}/build/AspectInjector/linux-x64/AspectInjector"
+          $SnExe = "${{ steps.find-snexe.outputs.path }}"
+          Get-ChildItem "./*/bin/*/*/Allure.*.dll" -Exclude "Allure.SpecFlow*","Allure.Xunit*" | ForEach-Object {
+            & $SnExe -vf $_.FullName
+          }
 
       - name: 'Pack project'
+        shell: pwsh
         run: |
-          dotnet pack ${{ env.SOLUTION_PATH }}\
-            --no-restore\
-            --no-build\
-            --configuration ${{ env.BUILD_CONFIGURATION }}\
+          dotnet pack ${{ env.SOLUTION_PATH }} `
+            --no-restore `
+            --no-build `
+            --configuration ${{ env.BUILD_CONFIGURATION }} `
+            "-p:PackageReleaseNotes=${{ github.event.release.html_url }}" `
             "-p:PackageOutputPath=${{ github.workspace }}/${{ env.PACKAGE_OUTPUT_PATH }}"
 
       - name: 'NuGet publish'
+        shell: pwsh
         run: |
-          dotnet nuget push "${{ env.PACKAGE_OUTPUT_PATH }}/*.nupkg"\
-            -k ${NUGET_TOKEN}\
+          dotnet nuget push "${{ env.PACKAGE_OUTPUT_PATH }}/*.nupkg" `
+            -k ${NUGET_TOKEN} `
             -s https://api.nuget.org/v3/index.json
         env:
           NUGET_TOKEN: ${{ secrets.NUGET_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -78,10 +78,6 @@ jobs:
           cat ./Allure.Reqnroll/allureConfig.Template.json
           sed -i -e '/"$schema"/s|/allure-csharp/[^/]*|/allure-csharp/${{ env.release_version }}|g' ./Allure.Reqnroll.Tests.Samples/allureConfig.json
           cat ./Allure.Reqnroll.Tests.Samples/allureConfig.json
-      - name: "Update release notes link"
-        run: |
-          sed -i -e '/<PackageReleaseNotes>/,/<\/PackageReleaseNotes>/ s|/tag/[0-9a-zA-Z.|-]*|/tag/${{ env.release_version }}|g' ./Directory.Build.props
-          cat ./Directory.Build.props
       - name: "Commit release version and create tag"
         run: |
           git commit -am "release ${{ env.release_version }}"
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,9 +1,8 @@
-name: Build
+name: Test
 
 env:
   SOLUTION_PATH: allure-csharp.sln
   BUILD_CONFIGURATION: 'Release'
-  PACKAGE_OUTPUT_PATH: 'artifacts'
 
 on:
   workflow_dispatch:
@@ -19,8 +18,7 @@ permissions:
   contents: read
 
 jobs:
-  build:
-    name: "Build"
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
diff --git a/Allure.NUnit/README.md b/Allure.NUnit/README.md
@@ -89,15 +89,3 @@ The following previously deprecated user API classes and methods were removed:
       instead.
   - `Allure.Net.Commons.Steps.CoreStepsHelper` - use functions from
     `Allure.Net.Commons.AllureApi` and `Allure.Net.Commons.ExtendedApi` instead.
-
-### For users of Mac with Apple silicon
-
-If you're developing on a Mac machine with Apple silicon, make sure you have
-Rosetta installed. Follow this article for the instructions:
-https://support.apple.com/en-us/HT211861
-
-You may also install Rosetta via the CLI:
-
-```shell
-/usr/sbin/softwareupdate --install-rosetta --agree-to-license
-```
diff --git a/Allure.Net.Commons/Allure.Net.Commons.csproj b/Allure.Net.Commons/Allure.Net.Commons.csproj
@@ -14,7 +14,7 @@
         <None Include="README.md" Pack="true" PackagePath="\" />
         <None Include="./../img/Allure-Color.png" Pack="true" PackagePath="\" />
         <Content Include="allureConfig.Template.json" Pack="true" />
-        <PackageReference Include="AspectInjector" Version="2.8.1" />
+        <PackageReference Include="AspectInjector" Version="2.9.0" />
         <PackageReference Include="MimeTypesMap" Version="1.0.8" />
         <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
         <PackageReference Include="System.Collections.Immutable" Version="5.0.0" />
diff --git a/Allure.Net.Commons/Internal/AssemblyAttributes.cs b/Allure.Net.Commons/Internal/AssemblyAttributes.cs
@@ -1,4 +1,28 @@
 ﻿using System.Runtime.CompilerServices;
 
-[assembly: InternalsVisibleTo("Allure.Net.Commons.Tests")]
-[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2")]
+[assembly: InternalsVisibleTo(
+    "Allure.Net.Commons.Tests, PublicKey=" +
+        "00240000048000009400000006020000" +
+        "00240000525341310004000001000100" +
+        "A5B2C91A39AB4B9F331EB97857938818" +
+        "181EFDE08132B2A00F27A007F8402C3C" +
+        "BAB29A13DAF3D22693D0A4BAF191D7AA" +
+        "BF32004ACA499E65532AE484D37DAD74" +
+        "822D45DBA8ED5365C03B34F372E6C534" +
+        "F609EAD50A3491497F0E5A3A7263986A" +
+        "5E670B69857D6BA01D61C43749132080" +
+        "BF8091D435E75F528E2A2C35EC34CBA0"
+)]
+[assembly: InternalsVisibleTo(
+    "DynamicProxyGenAssembly2, PublicKey=" +
+        "00240000048000009400000006020000" +
+        "00240000525341310004000001000100" +
+        "C547CAC37ABD99C8DB225EF2F6C8A360" +
+        "2F3B3606CC9891605D02BAA56104F4CF" +
+        "C0734AA39B93BF7852F7D9266654753C" +
+        "C297E7D2EDFE0BAC1CDCF9F717241550" +
+        "E0A7B191195B7667BB4F64BCB8E21213" +
+        "80FD1D9D46AD2D92D2D15605093924CC" +
+        "EAF74C4861EFF62ABF69B9291ED0A340" +
+        "E113BE11E6A7D3113E92484CF7045CC7"
+)]
diff --git a/Allure.Net.Commons/README.md b/Allure.Net.Commons/README.md
@@ -21,18 +21,6 @@ The library can be used by any project that targets a framework compatible with
 .NET Standard 2.0 (.NET Framework 4.6.1+, .NET Core 2.0+, .NET 5.0+, and more).
 See the complete list [here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version).
 
-## Note for users of Mac with Apple silicon
-
-If you're developing on a Mac machine with Apple silicon, make sure you have
-Rosetta installed. Follow this article for the instructions:
-https://support.apple.com/en-us/HT211861
-
-You may also install Rosetta via the CLI:
-
-```shell
-/usr/sbin/softwareupdate --install-rosetta --agree-to-license
-```
-
 ## Configuration
 
 The Allure lifecycle is configured via a JSON file with the default name
diff --git a/Allure.Reqnroll/Internal/AssemblyAttributes.cs b/Allure.Reqnroll/Internal/AssemblyAttributes.cs
@@ -1,3 +1,15 @@
 ﻿using System.Runtime.CompilerServices;
 
-[assembly: InternalsVisibleTo("Allure.Reqnroll.Tests")]
+[assembly: InternalsVisibleTo(
+    "Allure.Reqnroll.Tests, PublicKey=" +
+        "00240000048000009400000006020000" +
+        "00240000525341310004000001000100" +
+        "A5B2C91A39AB4B9F331EB97857938818" +
+        "181EFDE08132B2A00F27A007F8402C3C" +
+        "BAB29A13DAF3D22693D0A4BAF191D7AA" +
+        "BF32004ACA499E65532AE484D37DAD74" +
+        "822D45DBA8ED5365C03B34F372E6C534" +
+        "F609EAD50A3491497F0E5A3A7263986A" +
+        "5E670B69857D6BA01D61C43749132080" +
+        "BF8091D435E75F528E2A2C35EC34CBA0"
+)]
diff --git a/Allure.SpecFlow.Tests.Samples/Allure.SpecFlow.Tests.Samples.csproj b/Allure.SpecFlow.Tests.Samples/Allure.SpecFlow.Tests.Samples.csproj
@@ -1,6 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
+        <SignAssembly>false</SignAssembly>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/Allure.SpecFlow.Tests/Allure.SpecFlow.Tests.csproj b/Allure.SpecFlow.Tests/Allure.SpecFlow.Tests.csproj
@@ -2,6 +2,7 @@
 
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
+        <SignAssembly>false</SignAssembly>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/Allure.SpecFlow/Allure.SpecFlow.csproj b/Allure.SpecFlow/Allure.SpecFlow.csproj
@@ -11,6 +11,7 @@
         <Description>Create beautiful reports from your SpecFlow tests.</Description>
         <PackageIcon>Allure-SF-Color.png</PackageIcon>
         <PackageTags>$(PackageTags) specflow</PackageTags>
+        <SignAssembly>false</SignAssembly>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/Allure.SpecFlow/README.md b/Allure.SpecFlow/README.md
@@ -24,26 +24,16 @@ The adapter works with [SpecFlow](http://specflow.org/) version 3, starting from
 1. Install the [Allure.SpecFlow](https://www.nuget.org/packages/Allure.SpecFlow)
 Nuget package according to your SpecFlow version.
 2. Add the following entry to your `specflow.json`:
-    ```json
-    {
-      "stepAssemblies": [
-        {"assembly": "Allure.SpecFlowPlugin"}
-      ]
-    }
-    ```
-3. Run the tests.
-
-#### For users of Mac with Apple silicon
 
-If you're developing on a Mac machine with Apple silicon, make sure you have
-Rosetta installed. Follow this article for the instructions:
-https://support.apple.com/en-us/HT211861
+   ```json
+   {
+     "stepAssemblies": [
+       { "assembly": "Allure.SpecFlowPlugin" }
+     ]
+   }
+   ```
 
-You may also install Rosetta via the CLI:
-
-```shell
-/usr/sbin/softwareupdate --install-rosetta --agree-to-license
-```
+3. Run the tests.
 
 ### Further readings
 
diff --git a/Allure.Xunit.Examples/Allure.Xunit.Examples.csproj b/Allure.Xunit.Examples/Allure.Xunit.Examples.csproj
@@ -2,6 +2,7 @@
 
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
+        <SignAssembly>false</SignAssembly>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/Allure.Xunit/Allure.Xunit.csproj b/Allure.Xunit/Allure.Xunit.csproj
@@ -10,6 +10,7 @@
         <Description>Create beautiful reports from your xUnit.net tests.</Description>
         <PackageIcon>Allure-X-Color.png</PackageIcon>
         <PackageTags>$(PackageTags) xunit</PackageTags>
+        <SignAssembly>false</SignAssembly>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/Allure.Xunit/README.md b/Allure.Xunit/README.md
@@ -88,18 +88,6 @@ You should uninstall it and use attributes from the
 
 ## Known issues and limitations
 
-### Rosetta is required for users on Mac with Apple silicon
-
-If you're developing on a Mac machine with Apple silicon, make sure you have
-Rosetta installed. Follow this article for the instructions:
-https://support.apple.com/en-us/HT211861
-
-You may also install Rosetta via the CLI:
-
-```shell
-/usr/sbin/softwareupdate --install-rosetta --agree-to-license
-```
-
 ### MonoMod.Core issues
 
 We rely on Harmony (which in turn uses MonoMod.Core) to:
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -18,13 +18,12 @@
         <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageLicenseFile>LICENSE</PackageLicenseFile>
         <PackageTags>allure</PackageTags>
-        <PackageReleaseNotes>https://github.com/allure-framework/allure-csharp/releases/tag/2.12.1</PackageReleaseNotes>
     </PropertyGroup>
 
     <!-- Signing properties -->
     <PropertyGroup>
-        <SignAssembly>false</SignAssembly>
-        <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)key.snk</AssemblyOriginatorKeyFile>
+        <SignAssembly>true</SignAssembly>
+        <AssemblyOriginatorKeyFile>$([System.IO.Path]::Combine($(MSBuildThisFileDirectory), 'build', 'identity.snk'))</AssemblyOriginatorKeyFile>
     </PropertyGroup>
 
     <!-- Debug properties -->
diff --git a/Directory.Build.targets b/Directory.Build.targets
diff --git a/build/AspectInjector/linux-x64/AspectInjector b/build/AspectInjector/linux-x64/AspectInjector
diff --git a/build/TransformReadmeForNuget.cs b/build/TransformReadmeForNuget.cs
diff --git a/build/findvstool.ps1 b/build/findvstool.ps1
diff --git a/build/identity.snk b/build/identity.snk
