⬆️ Bump files with dotnet-file sync

# devlooped/oss - Introduce lazy-init of sponsoring status, simplify diagnostics devlooped/oss@5009784 - Switch to built-in item metadata for manifest analyzer files devlooped/oss@49c9a38 - Extend grace period to unknown status too devlooped/oss@9f918ec - Make sure we report only once per product for entire solution devlooped/oss@4b7f922 - Update to newest JsonWebTokens devlooped/oss@068140b - Improve default value for GenerateDocumentationFile devlooped/oss@b76de49 - Add SponsorLinkImported so we can skip imports devlooped/oss@c81f532 - Make sure Funding class is available to intellisense devlooped/oss@5813f21 - Fix formatting/whitespace devlooped/oss@7febebc - Add common sponsors metadata to assemblies devlooped/oss@0789bf0 - Update assembly metadata format for Funding.GitHub devlooped/oss@5801de0 - SponsorLink metadata will be opt-in only by analyzer projects devlooped/oss@c618ea8 - Fix roles checking from new identity-based token handler devlooped/oss@6eecf46 - Change debug traces location to the well-known location of .sponsorlink devlooped/oss@1019e2a - Remove unused tracing overloads devlooped/oss@08a8488 - Add support and showcase determining install time devlooped/oss@717ddb1 - Replace JWT package in tests targets too devlooped/oss@ba1310c - Update sponsor.yml to use org-access token devlooped/oss@96ca2b1 - Fix condition check for sender != owner devlooped/oss@49f34c0 - Try using dotnet-sponsor CLI for checks devlooped/oss@e04e3e0
devlooped · Jul 3, 2024 · e204da5 · e204da5
1 parent 3614d9b
commit e204da5
Show file tree

Hide file tree

Showing 21 changed files with 545 additions and 257 deletions.
diff --git a/.github/workflows/sponsor.yml b/.github/workflows/sponsor.yml
@@ -9,14 +9,58 @@ jobs:
   sponsor:
     runs-on: ubuntu-latest
     continue-on-error: true
-    env:
-      token: ${{ secrets.GH_TOKEN }}
-    if: ${{ !endsWith(github.event.sender.login, '[bot]') && !endsWith(github.event.sender.login, 'bot') }}      
+    if: ${{ !endsWith(github.event.sender.login, '[bot]') && github.event.sender.login != github.repository_owner }}      
     steps:
       - name: 🤘 checkout
-        if: env.token != ''
         uses: actions/checkout@v4
-
+
+      - name: ⚙ install
+        run: dotnet tool update -g dotnet-sponsor --prerelease
+
+      - name: 💻 setup
+        run: |
+          sponsor --version
+          pushd ~
+          git config -f .sponsorlink/.netconfig sponsorlink.id devlooped.sponsors.ci
+
+      - name: 🧪 run
+        shell: pwsh
+        env:
+          SPONSORABLE: ${{ secrets.GITHUB_TOKEN }}
+          TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          $env:TOKEN | sponsor sync $env:SPONSORABLE --tos --with-token
+          if ($LASTEXITCODE -eq -5) {
+              throw "Can not determine sponsorship with the provided token"
+          } elseif ($LASTEXITCODE -eq -6) {
+              Write-Output "User is not sponsoring, skipping"
+              exit 0
+          } elseif ($LASTEXITCODE -eq -3) {
+              Write-Output "$env:SPONSORABLE is not set up for SponsorLink"
+              exit 0
+          } elseif ($LASTEXITCODE -eq -4) {
+              Write-Output "$env:SPONSORABLE SponsorLink manifest is invalid"
+              exit 0
+          } elseif ($LASTEXITCODE -ne -0) {
+              Write-Output "Could not determine sponsor status"
+              exit $LASTEXITCODE
+          }
+
+          $roles = cat ~/.sponsorlink/github/$env:SPONSORABLE.jwt | jq -R 'split(".") | .[1] | @base64d | fromjson | .roles[]'
+          if (($roles | jq 'select(. == "team")' -r) -eq "team") { 
+            Write-Output "User is a team member, skipping"
+            exit 0 
+          } elseif (($roles | jq 'select(. == "contrib")' -r) -eq "contrib") {
+            Write-Output "User is a contributor!"
+          } else {
+            Write-Output "User is a sponsor"
+            if (($roles | jq 'select(. == "org")' -r) -eq "org") {
+              Write-Output "  (indirectly as a sponsoring organization member)"
+            } elseif (($roles | jq 'select(. == "user")' -r) -eq "user") {
+              Write-Output "  (as a direct sponsor)"
+            }
+          }
+        
       - name: 💜 sponsor 
         if: env.token != ''
         uses: devlooped/actions-sponsor@main

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -46,8 +46,6 @@
 
   <PropertyGroup Label="Build">
     <Configuration Condition="'$(Configuration)' == '' and $(CI)">Release</Configuration>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <GenerateDocumentationFile Condition="$(MSBuildProjectName.Contains('Tests'))">false</GenerateDocumentationFile>
     <LangVersion>Latest</LangVersion>
 
     <!-- See https://docs.microsoft.com/en-us/dotnet/standard/assembly/reference-assemblies -->

diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets
@@ -4,6 +4,13 @@
   <PropertyGroup Condition="'$(CI)' == 'true' and '$(Language)' == 'C#'">
     <DefineConstants>CI;$(DefineConstants)</DefineConstants>
   </PropertyGroup>
+
+  <PropertyGroup Label="Build">
+    <!-- Tests projects don't need API docs, typically -->
+    <GenerateDocumentationFile Condition="$(GenerateDocumentationFile) == '' and $(IsTestProject) == 'true'">false</GenerateDocumentationFile>
+    <GenerateDocumentationFile Condition="$(GenerateDocumentationFile) == '' amd $(MSBuildProjectName.Contains('Tests'))">false</GenerateDocumentationFile>
+    <GenerateDocumentationFile Condition="$(GenerateDocumentationFile) == ''">true</GenerateDocumentationFile>
+  </PropertyGroup>
 
   <PropertyGroup Condition="'$(IsPackable)' == ''">
     <IsPackable Condition="'$(PackAsTool)' == 'true'">true</IsPackable>

diff --git a/src/SponsorLink/Analyzer/StatusReportingAnalyzer.cs b/src/SponsorLink/Analyzer/StatusReportingAnalyzer.cs
@@ -1,25 +1,45 @@
-using System.Collections.Immutable;
+using System;
+using System.Collections.Immutable;
+using System.IO;
+using System.Linq;
 using Devlooped.Sponsors;
+using Humanizer;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
 using static Devlooped.Sponsors.SponsorLink;
 
 namespace Analyzer;
 
-[DiagnosticAnalyzer(LanguageNames.CSharp)]
+[DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
 public class StatusReportingAnalyzer : DiagnosticAnalyzer
 {
-    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray<DiagnosticDescriptor>.Empty;
+    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(new DiagnosticDescriptor(
+        "SL001", "Report Sponsoring Status", "Reports sponsoring status determined by SponsorLink", "Sponsors",
+        DiagnosticSeverity.Warning, true));
 
     public override void Initialize(AnalysisContext context)
     {
         context.EnableConcurrentExecution();
         context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
 
-        context.RegisterCodeBlockAction(c =>
+        context.RegisterCompilationAction(c =>
         {
-            var status = Diagnostics.GetStatus(Funding.Product);
-            Tracing.Trace($"Status: {status}");
+            var installed = c.Options.AdditionalFiles.Where(x =>
+            {
+                var options = c.Options.AnalyzerConfigOptionsProvider.GetOptions(x);
+                // In release builds, we'll have a single such item, since we IL-merge the analyzer.
+                return options.TryGetValue("build_metadata.Analyzer.ItemType", out var itemType) &&
+                       options.TryGetValue("build_metadata.Analyzer.NuGetPackageId", out var packageId) &&
+                       itemType == "Analyzer" &&
+                       packageId == "SponsorableLib";
+            }).Select(x => File.GetLastWriteTime(x.Path)).OrderByDescending(x => x).FirstOrDefault();
+
+            var status = Diagnostics.GetOrSetStatus(() => c.Options);
+
+            if (installed != default)
+                Tracing.Trace($"Status: {status}, Installed: {(DateTime.Now - installed).Humanize()} ago");
+            else
+                Tracing.Trace($"Status: {status}, unknown install time");
         });
     }
 }
diff --git a/src/SponsorLink/Analyzer/StatusReportingGenerator.cs b/src/SponsorLink/Analyzer/StatusReportingGenerator.cs
@@ -0,0 +1,20 @@
+using Devlooped.Sponsors;
+using Microsoft.CodeAnalysis;
+using static Devlooped.Sponsors.SponsorLink;
+
+namespace Analyzer;
+
+[Generator]
+public class StatusReportingGenerator : IIncrementalGenerator
+{
+    public void Initialize(IncrementalGeneratorInitializationContext context)
+    {
+        context.RegisterSourceOutput(
+            context.GetSponsorManifests(),
+            (spc, source) =>
+            {
+                var status = Diagnostics.GetOrSetStatus(source);
+                spc.AddSource("StatusReporting.cs", $"// Status: {status}");
+            });
+    }
+}
diff --git a/src/SponsorLink/Analyzer/buildTransitive/SponsorableLib.targets b/src/SponsorLink/Analyzer/buildTransitive/SponsorableLib.targets
@@ -1,3 +1,7 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Import Project="Devlooped.Sponsors.targets"/>
+  <ItemGroup>
+    <!-- Brings in the analyzer file to report installation time -->
+    <SponsorablePackageId Include="SponsorableLib" />
+  </ItemGroup>
 </Project>
diff --git a/src/SponsorLink/Library/Library.csproj b/src/SponsorLink/Library/Library.csproj
@@ -18,4 +18,8 @@
     <ProjectReference Include="..\Analyzer\Analyzer.csproj" ReferenceOutputAssembly="false" OutputType="Analyzer" />
   </ItemGroup>
 
+  <Target Name="Version" AfterTargets="GetPackageContents" DependsOnTargets="GetPackageTargetPath">
+    <Message Importance="high" Text="$(MSBuildProjectName) &gt; $(PackageTargetPath)" />
+  </Target>
+
 </Project>
diff --git a/src/SponsorLink/SponsorLink.Tests.targets b/src/SponsorLink/SponsorLink.Tests.targets
@@ -7,12 +7,12 @@
 
   <ItemGroup Condition="'$(ManagePackageVersionsCentrally)' == 'true'">
     <PackageReference Include="Humanizer.Core" VersionOverride="2.14.1" PrivateAssets="all" Pack="false" />
-    <PackageReference Include="System.IdentityModel.Tokens.Jwt" VersionOverride="7.6.0" PrivateAssets="all" Pack="false" />
+    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.2" PrivateAssets="all" Pack="false" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(ManagePackageVersionsCentrally)' != 'true'">
     <PackageReference Include="Humanizer.Core" Version="2.14.1" PrivateAssets="all" Pack="false" />
-    <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="7.6.0" PrivateAssets="all" Pack="false" />
+    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.2" PrivateAssets="all" Pack="false" />
   </ItemGroup>
 
   <Target Name="AddSponsorLinkAnalyzerDependencies" BeforeTargets="CoreCompile" DependsOnTargets="ResolveLockFileCopyLocalFiles">

diff --git a/src/SponsorLink/SponsorLink.targets b/src/SponsorLink/SponsorLink.targets
@@ -16,8 +16,8 @@
     <FundingProduct Condition="'$(FundingProduct)' == ''">$(Product)</FundingProduct>
     <!-- Default prefix is the joined upper-case letters in the product name (i.e. for ThisAssembly, TA) -->
     <FundingPrefix Condition="'$(FundingPrefix)' == ''">$([System.Text.RegularExpressions.Regex]::Replace("$(FundingProduct)", "[^A-Z]", ""))</FundingPrefix>
-    <!-- Default grace days for an expired sponsor manifest -->
-    <FundingGrace Condition="'$(FundingGrace)' == ''">21</FundingGrace>
+    <!-- Default grace days for an expired sponsor manifest or unknown status -->
+    <FundingGrace Condition="'$(FundingGrace)' == ''">15</FundingGrace>
   </PropertyGroup>
 
   <ItemGroup>
@@ -71,18 +71,18 @@
   <ItemGroup Condition="'$(ManagePackageVersionsCentrally)' == 'true'">
     <PackageReference Include="Humanizer.Core" VersionOverride="2.14.1" PrivateAssets="all" Pack="false" />
     <PackageReference Include="Humanizer.Core.es" VersionOverride="2.14.1" PrivateAssets="all" />
-    <PackageReference Include="System.IdentityModel.Tokens.Jwt" VersionOverride="7.6.0" PrivateAssets="all" Pack="false" />
+    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" VersionOverride="7.6.2" PrivateAssets="all" Pack="false" />
     <PackageReference Include="ILRepack" Version="2.0.33" VersionOverride="all" PrivateAssets="all" Pack="false" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(ManagePackageVersionsCentrally)' != 'true'">
     <PackageReference Include="Humanizer.Core" Version="2.14.1" PrivateAssets="all" Pack="false" />
     <PackageReference Include="Humanizer.Core.es" Version="2.14.1" PrivateAssets="all" />
-    <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="7.6.0" PrivateAssets="all" Pack="false" />
+    <PackageReference Include="Microsoft.IdentityModel.JsonWebTokens" Version="7.6.2" PrivateAssets="all" Pack="false" />
     <PackageReference Include="ILRepack" Version="2.0.33" PrivateAssets="all"  Pack="false" />
   </ItemGroup>
 
-  <Target Name="EmitFunding" BeforeTargets="GenerateMSBuildEditorConfigFileShouldRun" Inputs="$(MSBuildAllProjects)" Outputs="$(IntermediateOutputPath)SponsorLink.g.cs">
+  <Target Name="EmitFunding" BeforeTargets="CompileDesignTime;CoreCompile" Inputs="$(MSBuildAllProjects)" Outputs="$(IntermediateOutputPath)SponsorLink.g.cs">
     <PropertyGroup>
       <SponsorLinkPartial>namespace Devlooped.Sponsors%3B
 
@@ -183,4 +183,9 @@ partial class SponsorLink
     </ItemGroup>
   </Target>
 
+  <PropertyGroup>
+    <!-- Can be used in analyzer projects to detect double imports -->
+    <SponsorLinkImported>true</SponsorLinkImported>
+  </PropertyGroup>
+
 </Project>