Merge pull request #1127 from dotnet/dev/andarno/libtemplateUpdate

Merge Library.Template into v2.13

Author: AArnott

.agents/skills/bundle-dependency-prs/SKILL.md

@@ -0,0 +1,45 @@
+---
+name: bundle-dependency-prs
+description: Fix broken dependency update PRs and aggregate the ones that work into one PR.
+disable-model-invocation: true
+---
+
+# Instructions
+
+You have two goals:
+
+1. Get all dependency PRs to a state where their PR checks pass.
+2. Aggregate dependency PRs with passing checks into just one PR.
+
+You can identify dependency update PRs by those authored by `dependabot` or `renovate`.
+
+You'll find instructions for building and validating the repo in the [CONTRIBUTING.md](../../../CONTRIBUTING.md) doc.
+Always validate your changes locally before pushing them to the remote repository.
+
+When writing PR bodies or comments, avoid unmatched markdown code fences. Keep markdown well-formed.
+
+For purposes of assessing PR readiness by its PR checks, consider docfx related checks to be irrelevant.
+If a docfx check fails but all other checks succeed, then that is a 'successful' dependency update PR.
+
+## Fix up dependency PRs with failing checks
+
+Before aggregating PRs, first try to fix any individual dependency update PRs with failing build/test checks.
+
+1. For the dependency PRs with failing build or test PR checks, check out their source branch and fix any issues.
+2. Push your fixes as fresh commits to the individual dependency PRs.
+3. If you can't fix a particular PR, add a comment to the PR describing your attempt and outcome.
+
+## Group dependency PRs that are ready to go
+
+Your next goal is to collect all the dependency updates that are ready to go into a single PR.
+
+1. Prepare a local branch called `bulkDepUpdates`.
+   1. Consider that a remote branch by the same name may already exist. If it does, base your local branch on it.
+   2. Merge `origin/main` into this branch.
+   3. Resolve any conflicts.
+2. For the dependency PRs whose build and test PR checks already pass, merge them into the `bulkDepUpdates` branch.
+   Consider that your local branch may have already merged an equivalent PR in the past (from a past run). If so, you should skip merging that PR.
+   Resolve any conflicts.
+   Build and run tests to validate your branch.
+3. Push the branch.
+4. Create a PR, if one does not already exist.

.agents/skills/update-library-template/SKILL.md

@@ -0,0 +1,67 @@
+---
+name: update-library-template
+description: Merges the latest Library.Template into this repo (at position of HEAD) and resolves conflicts.
+disable-model-invocation: true
+---
+
+# Instructions
+
+1. Run `./tools/MergeFrom-Template.ps1` from the repo root.
+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](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.

.agents/skills/update-library-template/template-release-notes.md

@@ -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.

.config/dotnet-tools.json

@@ -3,32 +3,46 @@
   "isRoot": true,
   "tools": {
     "powershell": {
-      "version": "7.5.2",
+      "version": "7.6.4",
       "commands": [
         "pwsh"
       ],
       "rollForward": false
     },
     "dotnet-coverage": {
-      "version": "17.14.2",
+      "version": "18.9.0",
       "commands": [
         "dotnet-coverage"
       ],
       "rollForward": false
     },
     "nbgv": {
-      "version": "3.7.115",
+      "version": "3.10.91",
       "commands": [
         "nbgv"
       ],
       "rollForward": false
     },
     "docfx": {
-      "version": "2.78.3",
+      "version": "2.78.5",
       "commands": [
         "docfx"
       ],
       "rollForward": false
+    },
+    "nerdbank.dotnetrepotools": {
+      "version": "1.5.15",
+      "commands": [
+        "repo"
+      ],
+      "rollForward": false
+    },
+    "dotnet-symbol": {
+      "version": "9.0.661903",
+      "commands": [
+        "dotnet-symbol"
+      ],
+      "rollForward": false
     }
   }
 }

.devcontainer/Dockerfile

@@ -1,5 +1,5 @@
 # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions
-FROM mcr.microsoft.com/dotnet/sdk:9.0.304-noble@sha256:0b7186a7247bf8c07085fd700613bb0425a6f8f6467a0342c12a535e767da803
+FROM mcr.microsoft.com/dotnet/sdk:10.0.302@sha256:ed034a8bf0b24ded0cbbac07e17825d8e9ebfe21e308191d0f7421eaf5ad4664
 
 # Installing mono makes `dotnet test` work without errors even for net472.
 # But installing it takes a long time, so it's excluded by default.

.github/Prime-ForCopilot.ps1

@@ -0,0 +1,5 @@
+if ((git -C $PSScriptRoot rev-parse --is-shallow-repository) -eq 'true')
+{
+    Write-Host "Shallow clone detected, disabling NBGV Git engine so the build can succeed."
+    $env:NBGV_GitEngine='Disabled'
+}

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

@@ -14,46 +14,46 @@ runs:
 
   - name: 📢 Upload project.assets.json files
     if: always()
-    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     with:
       name: projectAssetsJson-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/projectAssetsJson
     continue-on-error: true
   - name: 📢 Upload variables
-    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     with:
       name: variables-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/Variables
     continue-on-error: true
   - name: 📢 Upload build_logs
     if: always()
-    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     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@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     with:
       name: testResults-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/testResults
     continue-on-error: true
   - name: 📢 Upload coverageResults
     if: always()
-    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     with:
       name: coverageResults-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/coverageResults
     continue-on-error: true
   - name: 📢 Upload symbols
-    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     with:
       name: symbols-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/symbols
     continue-on-error: true
   - name: 📢 Upload deployables
-    uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+    uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
     with:
       name: deployables-${{ runner.os }}
       path: ${{ runner.temp }}/_artifacts/deployables

.github/copilot-instructions.md

@@ -2,7 +2,7 @@
 	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
 	"extends": [
 		"config:best-practices",
-		"github>microsoft/vs-renovate-presets:dotnet_packages_below(9)"
+		"github>microsoft/vs-renovate-presets:dotnet_packages_LTS"
 	],
 	"semanticCommits": "disabled",
 	"labels": ["dependencies"],
@@ -15,6 +15,10 @@
 			"matchPackageNames": ["xunit*"],
 			"groupName": "xunit"
 		},
+		{
+			"matchPackageNames": ["Microsoft.Testing.Extensions.*"],
+			"groupName": "Microsoft Testing Platform"
+		},
 		{
 			"matchDatasources": ["dotnet-version", "docker"],
 			"matchDepNames": ["dotnet-sdk", "mcr.microsoft.com/dotnet/sdk"],

.github/renovate.json

@@ -12,7 +12,6 @@ on:
 env:
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
   BUILDCONFIGURATION: Release
-  # codecov_token: 4dc9e7e2-6b01-4932-a180-847b52b43d35 # Get a new one from https://codecov.io/
   NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages/
 
 jobs:
@@ -24,21 +23,21 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        - os: ubuntu-22.04
+        - os: ubuntu-24.04
           rid: linux
-        - os: macos-14
+        - os: macOS-15
           rid: osx
-        - os: windows-2022
+        - os: windows-2025
           rid: win
 
     steps:
-    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
       with:
         fetch-depth: 0 # avoid shallow clone so nbgv can do its work.
         submodules: true
     - name: ⚙ Install prerequisites
       run: |
-        ./init.ps1 -UpgradePrerequisites
+        ./init.ps1 -UpgradePrerequisites -NoNuGetCredProvider
         dotnet --info
 
         # Print mono version if it is present.
@@ -91,18 +90,20 @@ jobs:
       uses: ./.github/actions/publish-artifacts
       if: cancelled() == false
     - name: 📢 Publish code coverage results to codecov.io
-      run: ./tools/publish-CodeCov.ps1 -CodeCovToken "${{ env.codecov_token }}" -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}"
+      run: |
+        if ('${{ secrets.CODECOV_TOKEN }}') {
+          ./tools/publish-CodeCov.ps1 -CodeCovToken '${{ secrets.CODECOV_TOKEN }}' -PathToCodeCoverage "${{ runner.temp }}/_artifacts/coverageResults" -Name "${{ runner.os }} Coverage Results" -Flags "${{ runner.os }}"
+        }
       shell: pwsh
       timeout-minutes: 3
       continue-on-error: true
-      if: env.codecov_token != ''
 
   docs:
     name: 📃 Docs
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
     - name: 🔗 Markup Link Checker (mlc)
-      uses: becheran/mlc@18a06b3aa2901ca197de59c8b0b1f54fdba6b3fa # v1.0.0
+      uses: becheran/mlc@7ec24825cefe0c9c8c6bac48430e1f69e3ec356e # v1.2.0
       with:
-        args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/*,https://www.gitsponsors.com/ -p docfx,ext
+        args: --do-not-warn-for-redirect-to https://learn.microsoft.com*,https://dotnet.microsoft.com/*,https://dev.azure.com/*,https://app.codecov.io/* -p docfx,ext -i https://www.npmjs.com/package/*,https://get.dot.net/