Merge remote-tracking branch 'origin/main' into Tobbeman/main

Author: AArnott

.config/dotnet-tools.json

@@ -3,32 +3,39 @@
   "isRoot": true,
   "tools": {
     "powershell": {
-      "version": "7.5.0",
+      "version": "7.5.4",
       "commands": [
         "pwsh"
       ],
       "rollForward": false
     },
     "dotnet-coverage": {
-      "version": "17.13.1",
+      "version": "18.4.1",
       "commands": [
         "dotnet-coverage"
       ],
       "rollForward": false
     },
     "nbgv": {
-      "version": "3.7.115",
+      "version": "3.9.50",
       "commands": [
         "nbgv"
       ],
       "rollForward": false
     },
     "docfx": {
-      "version": "2.78.2",
+      "version": "2.78.4",
       "commands": [
         "docfx"
       ],
       "rollForward": false
+    },
+    "nerdbank.dotnetrepotools": {
+      "version": "1.1.1",
+      "commands": [
+        "repo"
+      ],
+      "rollForward": false
     }
   }
 }

.devcontainer/Dockerfile

@@ -14,46 +14,46 @@ runs:
 
   - name: 📢 Upload project.assets.json files
     if: always()
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: projectAssetsJson-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/projectAssetsJson
     continue-on-error: true
   - name: 📢 Upload variables
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: variables-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/Variables
     continue-on-error: true
   - name: 📢 Upload build_logs
     if: always()
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: build_logs-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/build_logs
     continue-on-error: true
   - name: 📢 Upload testResults
     if: always()
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: testResults-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/testResults
     continue-on-error: true
   - name: 📢 Upload coverageResults
     if: always()
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: coverageResults-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/coverageResults
     continue-on-error: true
   - name: 📢 Upload symbols
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: symbols-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/symbols
     continue-on-error: true
   - name: 📢 Upload deployables
-    uses: actions/upload-artifact@v4
+    uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
     with:
       name: deployables-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/deployables

.devcontainer/devcontainer.json

@@ -0,0 +1,82 @@
+# Copilot instructions for this repository
+
+## High level guidance
+
+* Review the `CONTRIBUTING.md` file for instructions to build and test the software.
+* Set the `NBGV_GitEngine` environment variable to `Disabled` before running any `dotnet` or `msbuild` commands.
+
+## Software Design
+
+* Design APIs to be highly testable, and all functionality should be tested.
+* Avoid introducing binary breaking changes in public APIs of projects under `src` unless their project files have `IsPackable` set to `false`.
+
+## Testing
+
+**IMPORTANT**: This repository uses Microsoft.Testing.Platform (MTP v2) with xunit v3. Traditional `--filter` syntax does NOT work. Use the options below instead.
+
+* There should generally be one test project (under the `test` directory) per shipping project (under the `src` directory). Test projects are named after the project being tested with a `.Tests` suffix.
+* Tests use xunit v3 with Microsoft.Testing.Platform (MTP v2). Traditional VSTest `--filter` syntax does NOT work.
+* Some tests are known to be unstable. When running tests, you should skip the unstable ones by using `-- --filter-not-trait "FailsInCloudTest=true"`.
+
+### Running Tests
+
+**Run all tests**:
+```bash
+dotnet test --no-build -c Release
+```
+
+**Run tests for a specific test project**:
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release
+```
+
+**Run a single test method**:
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-method ClassName.MethodName
+```
+
+**Run all tests in a test class**:
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-class ClassName
+```
+
+**Run tests with wildcard matching** (supports wildcards at beginning and/or end):
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-method "*Pattern*"
+```
+
+**Run tests with a specific trait** (equivalent to category filtering):
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-trait "TraitName=value"
+```
+
+**Exclude tests with a specific trait** (skip unstable tests):
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release -- --filter-not-trait "TestCategory=FailsInCloudTest"
+```
+
+**Run tests for a specific framework only**:
+```bash
+dotnet test --project test/Library.Tests/Library.Tests.csproj --no-build -c Release --framework net9.0
+```
+
+**List all available tests without running them**:
+```bash
+cd test/Library.Tests
+dotnet run --no-build -c Release --framework net9.0 -- --list-tests
+```
+
+**Key points about test filtering with MTP v2 / xunit v3**:
+- Options after `--` are passed to the test runner, not to `dotnet test`
+- Use `--filter-method`, `--filter-class`, `--filter-namespace` for simple filtering
+- Use `--filter-trait` and `--filter-not-trait` for trait-based filtering (replaces `--filter "TestCategory=..."`)
+- Traditional VSTest `--filter` expressions do NOT work
+- Wildcards `*` are supported at the beginning and/or end of filter values
+- Multiple simple filters of the same type use OR logic, different types combine with AND
+- See `--help` for query filter language for advanced scenarios
+
+## Coding style
+
+* Honor StyleCop rules and fix any reported build warnings *after* getting tests to pass.
+* In C# files, use namespace *statements* instead of namespace *blocks* for all new files.
+* Add API doc comments to all new public and internal members.

.github/actions/publish-artifacts/action.yaml

@@ -0,0 +1,20 @@
+# Template release notes
+
+This file will describe significant changes in Library.Template as they are introduced, especially if they require special consideration when merging updates into existing repos.
+This file is referenced by update-library-template.prompt.md and should remain in place to facilitate future merges, whether done manually or by AI.
+
+## Solution rename
+
+Never leave a Library.slnx file in the repository.
+You might even see one there even though this particular merge didn't bring it in.
+This can be an artifact of having renamed Library.sln to Library.slnx in the template repo, but ultimately the receiving repo should have only one .sln or .slnx file, with a better name than `Library`.
+Delete any `Library.slnx` that you see.
+Migrate an `.sln` in the repo root to `.slnx` using this command:
+
+```ps1
+dotnet solution EXISTING.sln migrate
+```
+
+This will create an EXISTING.slnx file. `git add` that file, then `git rm` the old `.sln` file.
+Sometimes a repo will reference the sln filename in a script or doc somewhere.
+Search the repo for such references and update them to the slnx file.

.github/copilot-instructions.md

@@ -0,0 +1,65 @@
+---
+description: Merges the latest Library.Template into this repo (at position of HEAD) and resolves conflicts.
+---
+
+# Instructions
+
+1. Run `tools/MergeFrom-Template.ps1`
+2. Resolve merge conflicts, taking into account conflict resolution policy below.
+3. Validate the changes, as described in the validation section below.
+4. Committing your changes (if applicable).
+
+## Conflict resolution policy
+
+There may be special notes in `.github/prompts/template-release-notes.md` that describe special considerations for certain files or scenarios to help you resolve conflicts appropriately.
+Always refer to that file before proceeding.
+In particular, focus on the *incoming* part of the file, since it represents the changes from the Library.Template that you are merging into your repo.
+
+Also consider that some repos choose to reject certain Library.Template patterns.
+For example the template uses MTPv2 for test projects, but a repo might have chosen not to adopt that.
+When resolving merge conflicts, consider whether it looks like the relevant code file is older than it should be given the changes the template is bringing in.
+Ask the user when in doubt as to whether the conflict should be resolved in favor of 'catching up' with the template or keeping the current changes.
+
+Use #runSubagent to analyze and resolve merge conflicts across files in parallel.
+
+### Keep Current files
+
+Conflicts in the following files should always be resolved by keeping the current version (i.e. discard incoming changes):
+
+* README.md
+
+### Deleted files
+
+Very typically, when the incoming change is to a file that was deleted locally, the correct resolution is to re-delete the file.
+
+In some cases however, the deleted file may have incoming changes that should be applied to other files.
+The `test/Library.Tests/Library.Tests.csproj` file is very typical of this.
+Changes to this file should very typically be applied to any and all test projects in the repo.
+You are responsible for doing this in addition to re-deleting this template file.
+
+## Validation
+
+Validate the merge result (after resolving any conflicts, if applicable).
+Use #runSubagent for each step.
+
+1. Verify that `dotnet restore` succeeds. Fix any issues that come up.
+2. Verify that `dotnet build` succeeds.
+3. Verify that tests succeed by running `tools/dotnet-test-cloud.ps1`.
+
+While these validations are described using `dotnet` CLI commands, some repos require using full msbuild.exe.
+You can detect this by checking the `azure-pipelines/dotnet.yml` or `.github/workflows/build.yml` files for use of one or the other tool.
+
+You are *not* responsible for fixing issues that the merge did not cause.
+If validation fails for reasons that seem unrelated to the changes brought in by the merge, advise the user and ask how they'd like you to proceed.
+That said, sometimes merges will bring in SDK or dependency updates that can cause breaks in seemingly unrelated areas.
+In such cases, you should investigate and solve the issues as needed.
+
+## Committing your changes
+
+If you have to make any changes for validations to pass, consider whether they qualify as a bad merge conflict resolution or more of a novel change that you're making to work with the Library.Template update.
+Merge conflict resolution fixes ideally get amended into the merge commit, while novel changes would go into a novel commit after the merge commit.
+
+Always author your commits using `git commit --author "🤖 Copilot <no-reply@github.com>"` (and possibly other parameters).
+Describe the nature of the merge conflicts you encountered and how you resolved them in your commit message.
+
+Later, if asked to review pull request validation breaks, always author a fresh commit with each fix that you push, unless the user directs you to do otherwise.

.github/prompts/template-release-notes.md

@@ -1,72 +1,27 @@
 {
 	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
-	"extends": ["config:recommended"],
-	"semanticCommits": "disabled",
-	"labels": ["dependencies"],
+	"extends": [
+		"github>microsoft/vs-renovate-presets:microbuild",
+		"github>microsoft/vs-renovate-presets:vs_main_dependencies",
+		"github>microsoft/vs-renovate-presets:dotnet_packages_LTS",
+		"github>microsoft/vs-renovate-presets:xunitv2"
+	],
 	"packageRules": [
 		{
-			"matchPackageNames": ["nbgv", "nerdbank.gitversioning"],
-			"groupName": "nbgv and nerdbank.gitversioning updates"
-		},
-		{
-			"matchPackageNames": ["xunit*"],
-			"groupName": "xunit"
-		},
-		{
-			"matchPackageNames": ["xunit.runner.visualstudio"],
-			"allowedVersions": "<3.0"
-		},
-		{
-			"matchPackageNames": ["xunit.combinatorial"],
-			"allowedVersions": "<2.0"
-		},
-		{
-			"matchDatasources": ["dotnet-version", "docker"],
-			"matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"],
-			"groupName": "Dockerfile and global.json updates"
-		},
-		{
-			"matchPackageNames": ["*"],
-			"allowedVersions": "!/-g[a-f0-9]+$/"
-		},
-		{
-			"matchPackageNames": [
-				"System.Collections.Immutable",
-				"System.Composition*",
-				"System.Diagnostics.DiagnosticSource",
-				"System.IO.Pipelines",
-				"System.Reflection.Metadata",
-				"System.Text.Json",
-				"System.Threading.Tasks.Dataflow",
-				"Microsoft.Bcl.AsyncInterfaces"
-			],
-			"allowedVersions": "<9.0",
-			"groupName": "Included in .NET runtime"
-		},
-		{
-			"matchPackageNames": ["Microsoft.VisualStudio.Internal.MicroBuild*"],
-			"groupName": "microbuild"
-		},
-		{
-			"matchPackageNames": ["Microsoft.VisualStudio.*"],
-			"groupName": "Visual Studio SDK"
-		},
-		{
-			"matchPackageNames": ["Microsoft.VisualStudio.*"],
-			"matchUpdateTypes": ["patch"],
-			"enabled": false
-		},
-		{
-			"matchJsonata": [ "sharedVariableName='CodeAnalysisVersion'" ],
+			"matchJsonata": ["sharedVariableName='CodeAnalysisVersion'"],
 			"enabled": false
 		}
 	],
 	"customManagers": [
 		{
 			"customType": "regex",
 			"datasourceTemplate": "nuget",
-			"fileMatch": ["test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs"],
-			"matchStrings": ["PackageIdentity\\(\"(?<packageName>[^\"]+)\", \"(?<currentValue>[^\"]+)\"\\)"]
+			"managerFilePatterns": [
+				"test/Microsoft.VisualStudio.Threading.Analyzers.Tests/Helpers/ReferencesHelper.cs"
+			],
+			"matchStrings": [
+				"PackageIdentity\\(\"(?<packageName>[^\"]+)\", \"(?<currentValue>[^\"]+)\"\\)"
+			]
 		}
 	]
 }