Cache NuGet Packages (GitHub Actions) (#1172)

* feat: Added packages.lock.json

* ci: Add cache step

* Regenerate github workflows

* Rebuild packages.lock.json files with latest dependencies

* Exclude packages.lock.json from editorconfig checks

The packages.lock.json files are auto-generated by .NET and don't
include a final newline, causing the editorconfig checker to fail.
Since we can't control the format of these generated files, we
exclude them from the checks.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Revert "Rebuild packages.lock.json files with latest dependencies"

This reverts commit a022a27.

* Revert "feat: Added packages.lock.json"

This reverts commit 1f64653.

* .github/workflows/Generate-TestWorkflows.ps1: Removed step to set DOTNET_CLI_TELEMETRY_OPTOUT and DOTNET_NOLOGO actively and added them to the job directly. This step was taking 5-6 seconds just to set some variables.

* .github/workflows/Generate-TestWorflows.ps1: Removed cache step, but keep restore separate to determine how much time restore vs build takes

* Regenerated test workflows

* Directory.Build.props: Whitespace only commit to trigger build

* .github/workflows/Generate-TestWorkflows.ps1: Added --no-cache --force to restore as a temporary step to bust the old caching to get the build running

* Regenerated test workflows

* .github/workflows/Generate-TestWorkflows.ps1: Added missing TestFrameworks=true parameter on dotnet restore command. This is required to enable all target frameworks for tests.

* Regenerated test workflows

* .github/workflows/Generate-TestWorkflows.ps1: Added cache step with key based on all MSBuild files that manage package versions and references

* Regenerated test workflows

* .github/workflows/Generate-TestWorkflows.ps1: Set the NUGET_PACKAGES directory, since we use it for cache stability and the agent doesn't set it

* Regenerated test workflows

* Lucene.Net.Tests.AllProjects: Whitespace only change to test cache hit

* Lucene.Net.Tests.AllProjects: Whitespace only change to test cache miss

* Revert "Lucene.Net.Tests.AllProjects: Whitespace only change to test cache miss"

This reverts commit 6e02d03.

* Revert "Lucene.Net.Tests.AllProjects: Whitespace only change to test cache hit"

This reverts commit c5250b9.

* Revert "Directory.Build.props: Whitespace only commit to trigger build"

This reverts commit 60201c1.

* .github/workflows/sonar.yml: Updated to use the same cache key as other workflows that require dotnet restore

* .github/workflows/sonar.yml: Temporarily enable in PRs for testing purposes

* Lucene.Net.Expressions: Added private dependency on Antlr4.CodeGenerator, which contains a .jar file that Antlr4BuildTasks depends on.

* .github/workflows/sonar.yml: Added env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS to the cache key, restore, and build to ensure that all of the test target frameworks are included in the cache and scan

* .github/workflows/sonar.yml: Bumped action versions - setup-dotnet@v5, setup-java@v5, checkout@v5, cache@v4. Also changed shell to pwsh rather than powershell, where specified.

* .github/workflows/Generate-TestWorkflows.ps1: Added env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS to the cache key, restore, and build to ensure that all of the test target frameworks are inlcuded in the cache (or we get a separate cache)

* .github/workflows/Generate-TestWorkflows.ps1: Bumped action versions - setup-dotnet@v5, checkout@v5

* Regenerated test workflows

* Revert ".github/workflows/sonar.yml: Temporarily enable in PRs for testing purposes"

This reverts commit 3e77d68.

* Lucene.Net.Expressions.csproj: Exclude all assets from Antlr4.CodeGenerator. We are only after the .jar file.

* Lucene.Net.Expressions: Set the Antlr4ToolPath so Antlr4BuildTasks can find the jar file without including any assets from Antlr4.CodeGenerator.

* Lucene.Net.Expressions.csproj: Fixed .editorconfig rule violation

* .github/workflows/Generate-TestWorkflows.ps1: Added task to post test results to the GitHub Actions summary

* Regenerated test workflows

---------

Co-authored-by: Nikolaj Brask-Nielsen <nikolajgive@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Shad Storhaug <shad@shadstorhaug.com>

Author: 4 people

.build/dependencies.props

@@ -20,6 +20,7 @@
 -->
 <Project>
   <PropertyGroup Label="NuGet Package Reference Versions">
+    <Antlr4CodeGeneratorPackageVersion>4.6.6</Antlr4CodeGeneratorPackageVersion>
     <Antlr4RuntimeStandardPackageVersion>4.13.1</Antlr4RuntimeStandardPackageVersion>
     <Antlr4BuildTasksPackageVersion>12.8.0</Antlr4BuildTasksPackageVersion>
     <!-- LUCENENET TODO: When ICU4N is released to production,

.editorconfig-checker.json

@@ -8,7 +8,8 @@
     "\\.resx$",
     "\\.DotSettings$",
     "App\\.config$",
-    "\\.htaccess$"
+    "\\.htaccess$",
+    "packages\\.lock\\.json$"
   ],
   "AllowedContentTypes": [],
   "PassedFiles": [],

.github/workflows/Generate-TestWorkflows.ps1

@@ -1,4 +1,4 @@
-# -----------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------------
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
 # contributor license agreements.  See the NOTICE file distributed with
@@ -258,8 +258,11 @@ jobs:
           - os: macos-latest
             framework: net472
     env:
+      DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      DOTNET_NOLOGO: 1
+      NUGET_PACKAGES: `${{ github.workspace }}/.nuget/packages
+      BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS: 'true'
       project_path: '$projectRelativePath'"
-
     if ($isCLI) {
         $fileText += "
       project_under_test_path: '$luceneCliProjectPath'
@@ -275,30 +278,38 @@ jobs:
 
     steps:
       - name: Checkout Source Code
-        uses: actions/checkout@v3
-
-      - name: Disable .NET SDK Telemetry and Logo
-        run: |
-          echo `"DOTNET_NOLOGO=1`" | Out-File -FilePath  `$env:GITHUB_ENV -Encoding utf8 -Append
-          echo `"DOTNET_CLI_TELEMETRY_OPTOUT=1`" | Out-File -FilePath  `$env:GITHUB_ENV -Encoding utf8 -Append
-        shell: pwsh
+        uses: actions/checkout@v5
 
       - name: Setup .NET 6 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '$DotNet6SDKVersion'
         if: `${{ startswith(matrix.framework, 'net6.') }}
 
       - name: Setup .NET 8 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '$DotNet8SDKVersion'
 
       - name: Setup .NET 9 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '$DotNet9SDKVersion'
 
+      - name: Cache NuGet Packages
+        uses: actions/cache@v4
+        with:
+          # '**/*.*proj' includes .csproj, .vbproj, .fsproj, msbuildproj, etc.
+          # '**/*.props' includes Directory.Packages.props, Directory.Build.props and Dependencies.props
+          # '**/*.targets' includes Directory.Build.targets
+          # '**/*.sln' and '*.sln' ensure root solution files are included (minimatch glitch for file extension .sln)
+          # 'global.json' included for SDK version changes
+          key: nuget-`${{ runner.os }}-`${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}-`${{ hashFiles('**/*.*proj', '**/*.props', '**/*.targets', '**/*.sln', '*.sln', 'global.json') }}
+          path: `${{ env.NUGET_PACKAGES }}
+
+      - name: Restore
+        run: dotnet restore /p:TestFrameworks=`${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}
+
       - name: Setup Environment Variables
         run: |
           `$project_name = [System.IO.Path]::GetFileNameWithoutExtension(`$env:project_path)
@@ -312,17 +323,17 @@ jobs:
           # Set the Azure DevOps default working directory env variable, so our tests only need to deal with a single env variable
           echo `"SYSTEM_DEFAULTWORKINGDIRECTORY=`$working_directory`" | Out-File -FilePath  `$env:GITHUB_ENV -Encoding utf8 -Append
           # Title for LiquidTestReports.Markdown
-          echo `"title=Test Run for `$project_name - `${{matrix.framework}} - `${{matrix.platform}} - `${{matrix.os}}`" | Out-File -FilePath  `$env:GITHUB_ENV -Encoding utf8 -Append
+          echo `"title=Test Results for `$project_name - `${{matrix.framework}} - `${{matrix.platform}} - `${{matrix.os}}`" | Out-File -FilePath  `$env:GITHUB_ENV -Encoding utf8 -Append
         shell: pwsh"
 
     if ($isCLI) {
         # Special case: Generate lucene-cli.nupkg for installation test so the test runner doesn't have to do it
         $fileText += "
-      - run: dotnet pack `${{env.project_under_test_path}} --configuration `${{matrix.configuration}} /p:TestFrameworks=true /p:PortableDebugTypeOnly=true"
+      - run: dotnet pack `${{env.project_under_test_path}} --configuration `${{matrix.configuration}} --no-restore /p:TestFrameworks=`${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }} /p:PortableDebugTypeOnly=true"
     }
 
     $fileText += "
-      - run: dotnet build `${{env.project_path}} --configuration `${{matrix.configuration}} --framework `${{matrix.framework}} /p:TestFrameworks=true
+      - run: dotnet build `${{env.project_path}} --configuration `${{matrix.configuration}} --framework `${{matrix.framework}} --no-restore /p:TestFrameworks=`${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}
       - run: dotnet test `${{env.project_path}} --configuration `${{matrix.configuration}} --framework `${{matrix.framework}} --no-build --no-restore --blame-hang --blame-hang-dump-type mini --blame-hang-timeout 20minutes --logger:`"console;verbosity=normal`" --logger:`"trx;LogFileName=`${{env.trx_file_name}}`" --logger:`"liquid.md;LogFileName=`${{env.md_file_name}};Title=`${{env.title}};`" --results-directory:`"`${{github.workspace}}/`${{env.test_results_artifact_name}}/`${{env.project_name}}`" -- RunConfiguration.TargetPlatform=`${{matrix.platform}} NUnit.DisplayName=FullName TestRunParameters.Parameter\(name=\`"tests:slow\`",\ value=\`"\`${{env.run_slow_tests}}\`"\)
         shell: bash
       # upload reports as build artifacts
@@ -332,6 +343,14 @@ jobs:
         with:
           name: '`${{env.test_results_artifact_name}}'
           path: '`${{github.workspace}}/`${{env.test_results_artifact_name}}'
+      - name: Output Test Summary
+        if: `${{always()}}
+        shell: pwsh
+        run: |
+          `$md_file = Join-Path `${{github.workspace}} `${{env.test_results_artifact_name}} `${{env.project_name}} `${{env.md_file_name}}
+          if (Test-Path `$md_file) {
+              Get-Content `$md_file | Add-Content `$env:GITHUB_STEP_SUMMARY
+          }
 "
 
     # GitHub Actions does not support filenames with "." in them, so replace

.github/workflows/Lucene-Net-Tests-AllProjects.yml

@@ -1,4 +1,4 @@
-####################################################################################
+####################################################################################
 # DO NOT EDIT: This file was automatically generated by Generate-TestWorkflows.ps1
 ####################################################################################
 # Licensed to the Apache Software Foundation (ASF) under one
@@ -86,37 +86,49 @@ jobs:
           - os: macos-latest
             framework: net472
     env:
+      DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      DOTNET_NOLOGO: 1
+      NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
+      BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS: 'true'
       project_path: './src/Lucene.Net.Tests.AllProjects/Lucene.Net.Tests.AllProjects.csproj'
       run_slow_tests: 'false'
       trx_file_name: 'TestResults.trx'
       md_file_name: 'TestResults.md' # Report file name for LiquidTestReports.Markdown
 
     steps:
       - name: Checkout Source Code
-        uses: actions/checkout@v3
-
-      - name: Disable .NET SDK Telemetry and Logo
-        run: |
-          echo "DOTNET_NOLOGO=1" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
-          echo "DOTNET_CLI_TELEMETRY_OPTOUT=1" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
-        shell: pwsh
+        uses: actions/checkout@v5
 
       - name: Setup .NET 6 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '6.0.x'
         if: ${{ startswith(matrix.framework, 'net6.') }}
 
       - name: Setup .NET 8 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '8.0.x'
 
       - name: Setup .NET 9 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '9.0.x'
 
+      - name: Cache NuGet Packages
+        uses: actions/cache@v4
+        with:
+          # '**/*.*proj' includes .csproj, .vbproj, .fsproj, msbuildproj, etc.
+          # '**/*.props' includes Directory.Packages.props, Directory.Build.props and Dependencies.props
+          # '**/*.targets' includes Directory.Build.targets
+          # '**/*.sln' and '*.sln' ensure root solution files are included (minimatch glitch for file extension .sln)
+          # 'global.json' included for SDK version changes
+          key: nuget-${{ runner.os }}-${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}-${{ hashFiles('**/*.*proj', '**/*.props', '**/*.targets', '**/*.sln', '*.sln', 'global.json') }}
+          path: ${{ env.NUGET_PACKAGES }}
+
+      - name: Restore
+        run: dotnet restore /p:TestFrameworks=${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}
+
       - name: Setup Environment Variables
         run: |
           $project_name = [System.IO.Path]::GetFileNameWithoutExtension($env:project_path)
@@ -130,9 +142,9 @@ jobs:
           # Set the Azure DevOps default working directory env variable, so our tests only need to deal with a single env variable
           echo "SYSTEM_DEFAULTWORKINGDIRECTORY=$working_directory" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
           # Title for LiquidTestReports.Markdown
-          echo "title=Test Run for $project_name - ${{matrix.framework}} - ${{matrix.platform}} - ${{matrix.os}}" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
+          echo "title=Test Results for $project_name - ${{matrix.framework}} - ${{matrix.platform}} - ${{matrix.os}}" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
         shell: pwsh
-      - run: dotnet build ${{env.project_path}} --configuration ${{matrix.configuration}} --framework ${{matrix.framework}} /p:TestFrameworks=true
+      - run: dotnet build ${{env.project_path}} --configuration ${{matrix.configuration}} --framework ${{matrix.framework}} --no-restore /p:TestFrameworks=${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}
       - run: dotnet test ${{env.project_path}} --configuration ${{matrix.configuration}} --framework ${{matrix.framework}} --no-build --no-restore --blame-hang --blame-hang-dump-type mini --blame-hang-timeout 20minutes --logger:"console;verbosity=normal" --logger:"trx;LogFileName=${{env.trx_file_name}}" --logger:"liquid.md;LogFileName=${{env.md_file_name}};Title=${{env.title}};" --results-directory:"${{github.workspace}}/${{env.test_results_artifact_name}}/${{env.project_name}}" -- RunConfiguration.TargetPlatform=${{matrix.platform}} NUnit.DisplayName=FullName TestRunParameters.Parameter\(name=\"tests:slow\",\ value=\"\${{env.run_slow_tests}}\"\)
         shell: bash
       # upload reports as build artifacts
@@ -142,4 +154,12 @@ jobs:
         with:
           name: '${{env.test_results_artifact_name}}'
           path: '${{github.workspace}}/${{env.test_results_artifact_name}}'
+      - name: Output Test Summary
+        if: ${{always()}}
+        shell: pwsh
+        run: |
+          $md_file = Join-Path ${{github.workspace}} ${{env.test_results_artifact_name}} ${{env.project_name}} ${{env.md_file_name}}
+          if (Test-Path $md_file) {
+              Get-Content $md_file | Add-Content $env:GITHUB_STEP_SUMMARY
+          }
 

.github/workflows/Lucene-Net-Tests-Analysis-Common.yml

@@ -1,4 +1,4 @@
-####################################################################################
+####################################################################################
 # DO NOT EDIT: This file was automatically generated by Generate-TestWorkflows.ps1
 ####################################################################################
 # Licensed to the Apache Software Foundation (ASF) under one
@@ -70,37 +70,49 @@ jobs:
           - os: macos-latest
             framework: net472
     env:
+      DOTNET_CLI_TELEMETRY_OPTOUT: 1
+      DOTNET_NOLOGO: 1
+      NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
+      BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS: 'true'
       project_path: './src/Lucene.Net.Tests.Analysis.Common/Lucene.Net.Tests.Analysis.Common.csproj'
       run_slow_tests: 'false'
       trx_file_name: 'TestResults.trx'
       md_file_name: 'TestResults.md' # Report file name for LiquidTestReports.Markdown
 
     steps:
       - name: Checkout Source Code
-        uses: actions/checkout@v3
-
-      - name: Disable .NET SDK Telemetry and Logo
-        run: |
-          echo "DOTNET_NOLOGO=1" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
-          echo "DOTNET_CLI_TELEMETRY_OPTOUT=1" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
-        shell: pwsh
+        uses: actions/checkout@v5
 
       - name: Setup .NET 6 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '6.0.x'
         if: ${{ startswith(matrix.framework, 'net6.') }}
 
       - name: Setup .NET 8 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '8.0.x'
 
       - name: Setup .NET 9 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '9.0.x'
 
+      - name: Cache NuGet Packages
+        uses: actions/cache@v4
+        with:
+          # '**/*.*proj' includes .csproj, .vbproj, .fsproj, msbuildproj, etc.
+          # '**/*.props' includes Directory.Packages.props, Directory.Build.props and Dependencies.props
+          # '**/*.targets' includes Directory.Build.targets
+          # '**/*.sln' and '*.sln' ensure root solution files are included (minimatch glitch for file extension .sln)
+          # 'global.json' included for SDK version changes
+          key: nuget-${{ runner.os }}-${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}-${{ hashFiles('**/*.*proj', '**/*.props', '**/*.targets', '**/*.sln', '*.sln', 'global.json') }}
+          path: ${{ env.NUGET_PACKAGES }}
+
+      - name: Restore
+        run: dotnet restore /p:TestFrameworks=${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}
+
       - name: Setup Environment Variables
         run: |
           $project_name = [System.IO.Path]::GetFileNameWithoutExtension($env:project_path)
@@ -114,9 +126,9 @@ jobs:
           # Set the Azure DevOps default working directory env variable, so our tests only need to deal with a single env variable
           echo "SYSTEM_DEFAULTWORKINGDIRECTORY=$working_directory" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
           # Title for LiquidTestReports.Markdown
-          echo "title=Test Run for $project_name - ${{matrix.framework}} - ${{matrix.platform}} - ${{matrix.os}}" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
+          echo "title=Test Results for $project_name - ${{matrix.framework}} - ${{matrix.platform}} - ${{matrix.os}}" | Out-File -FilePath  $env:GITHUB_ENV -Encoding utf8 -Append
         shell: pwsh
-      - run: dotnet build ${{env.project_path}} --configuration ${{matrix.configuration}} --framework ${{matrix.framework}} /p:TestFrameworks=true
+      - run: dotnet build ${{env.project_path}} --configuration ${{matrix.configuration}} --framework ${{matrix.framework}} --no-restore /p:TestFrameworks=${{ env.BUILD_FOR_ALL_TEST_TARGET_FRAMEWORKS }}
       - run: dotnet test ${{env.project_path}} --configuration ${{matrix.configuration}} --framework ${{matrix.framework}} --no-build --no-restore --blame-hang --blame-hang-dump-type mini --blame-hang-timeout 20minutes --logger:"console;verbosity=normal" --logger:"trx;LogFileName=${{env.trx_file_name}}" --logger:"liquid.md;LogFileName=${{env.md_file_name}};Title=${{env.title}};" --results-directory:"${{github.workspace}}/${{env.test_results_artifact_name}}/${{env.project_name}}" -- RunConfiguration.TargetPlatform=${{matrix.platform}} NUnit.DisplayName=FullName TestRunParameters.Parameter\(name=\"tests:slow\",\ value=\"\${{env.run_slow_tests}}\"\)
         shell: bash
       # upload reports as build artifacts
@@ -126,4 +138,12 @@ jobs:
         with:
           name: '${{env.test_results_artifact_name}}'
           path: '${{github.workspace}}/${{env.test_results_artifact_name}}'
+      - name: Output Test Summary
+        if: ${{always()}}
+        shell: pwsh
+        run: |
+          $md_file = Join-Path ${{github.workspace}} ${{env.test_results_artifact_name}} ${{env.project_name}} ${{env.md_file_name}}
+          if (Test-Path $md_file) {
+              Get-Content $md_file | Add-Content $env:GITHUB_STEP_SUMMARY
+          }