Track sourceLink and resources in deterministic key by Copilot · Pull Request #81629 · dotnet/roslyn

Copilot · 2025-12-10T02:59:59Z

This PR adds tracking for source link files and resources to the compiler's deterministic key file to ensure all compilation inputs that affect reproducible builds are properly tracked. The implementation includes calculating checksums for source link content and manifest resources (tracking name, fileName, isPublic, and content checksum), while ruleset tracking was deemed unnecessary since rulesets only affect compilation through diagnostic options that are already being tracked.

Original prompt

This section details on the original issue you should resolve

<issue_title>Missing inputs in the key file</issue_title>
<issue_description>Recently discovered that there are several inputs we are not tracking in the key file that need to be tracked:

source link file

ruleset file

resources

</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Missing inputs in the key file #65474

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

jcouv · 2025-12-10T04:59:40Z

@copilot CI produced src/Compilers/Core/Portable/Compilation/DeterministicKeyBuilder.cs(434,31): error IDE0060: (NETCORE_ENGINEERING_TELEMETRY=Build) Remove unused parameter 'cancellationToken'

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot · 2025-12-10T05:05:40Z

@copilot CI produced src/Compilers/Core/Portable/Compilation/DeterministicKeyBuilder.cs(434,31): error IDE0060: (NETCORE_ENGINEERING_TELEMETRY=Build) Remove unused parameter 'cancellationToken'

Fixed in 08c5f38. Removed the unused cancellationToken parameter from the WriteEmitOptions method signature and its call site.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

sc4vsblobprodcus331.vsblob.vsassets.io
- Triggering command: /usr/share/dotnet/dotnet dotnet build src/Compilers/Core/Portable/Microsoft.CodeAnalysis.csproj (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

jcouv · 2025-12-10T05:20:42Z

@copilot GetKey(...) already handles default inputs (additionalTexts, analyzers, generators, resources, ...). There is no need for the caller of GetKey to also do NullToEmpty() on those.

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot · 2025-12-10T05:26:07Z

@copilot GetKey(...) already handles default inputs (additionalTexts, analyzers, generators, resources, ...). There is no need for the caller of GetKey to also do NullToEmpty() on those.

Fixed in e4530d3. Removed the redundant NullToEmpty() calls from the caller since GetKey() already handles default inputs internally.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

sc4vsblobprodcus331.vsblob.vsassets.io
- Triggering command: /usr/share/dotnet/dotnet dotnet build src/Compilers/Core/Portable/Microsoft.CodeAnalysis.csproj (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

jcouv · 2025-12-10T06:08:47Z

@copilot We should care about the ruleset contents, not just the path to the ruleset file

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot · 2025-12-10T06:24:32Z

@copilot We should care about the ruleset contents, not just the path to the ruleset file

Fixed in 2fac371. Changed from tracking ruleset file path to tracking ruleset content with checksum (similar to source link). The ruleset file is now opened and read as SourceText, with its checksum written to compilation.options.ruleSet.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

sc4vsblobprodcus331.vsblob.vsassets.io
- Triggering command: /usr/share/dotnet/dotnet dotnet build src/Compilers/Core/Portable/Microsoft.CodeAnalysis.csproj (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

jcouv · 2025-12-10T06:46:43Z

@copilot Remove IsEmbedded. It is redundant with FileName and we need FileName for non-embedded scenarios

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

…nputs-key-file

jaredpar · 2025-12-12T19:36:11Z

+                    using var stream = resource.DataProvider();
+                    var sourceText = SourceText.From(stream, encoding: null, checksumAlgorithm: SourceHashAlgorithms.Default);
+                    WriteSourceText(writer, sourceText);


Why are you converting to a SourceText here? These resources are generally treated as binary blobs in the codebase. My intuition would be that we just grab the raw Stream or byte[] and hash that. Not sure if we'd hit weird edge cases trying to view a binary as a source text.

jcouv · 2025-12-19T07:34:43Z

~~I'm investigating the determinism failure in CI with Microsoft.VisualStudio.Extensibility.Testing.Xunit:~~ Resolved by adding the key file to the skip list (thanks Jared for the tip).

...
  "resources": [
    {
      "resourceName": "Microsoft.VisualStudio.IntegrationTestService.dll",
      "fileName": null,
      "isPublic": true,
      "content": {
        "checksum": "da3a9f2c2fc2de2bf0254f9f13e15726c7a260ab318acff9a77790ccc344a",
        "checksumAlgorithm": "Sha256"
      }
    },
    {
      "resourceName": "Microsoft.VisualStudio.IntegrationTestService.vsix",
      "fileName": null,
      "isPublic": true,
      "content": {
+      "checksum": "c88fbb3f45e9c061775c57b763ba4e3988857883a253d03ac7bed44bf113af9c", // Right
-      "checksum": "876736d2ee98f2c4cac77a7fac592adbd14924d583f914cf873dc67366c2f8c", // Left
        "checksumAlgorithm": "Sha256"
      }
    }
  ]
}

…nputs-key-file

…p list

…y to skip list" This reverts commit 504439a.

…ey to skip list" This reverts commit dd56447.

AlekseyTs · 2026-01-13T14:38:27Z

  # The VSIX build is not deterministic (for example the catalog.json contains a randomly generated identifier for the install location).
-  "Microsoft.VisualStudio.Extensibility.Testing.Xunit.dll"
+  "Microsoft.VisualStudio.Extensibility.Testing.Xunit.dll",
+  "Microsoft.VisualStudio.Extensibility.Testing.Xunit.dll.key"


.key

Is this addition intentional?

Yes, the key file didn't use to include some inputs, which are not the same across rebuilds (ie. a VSIX file). Now the key file includes them and thus varies across rebuilds as well.

AlekseyTs

LGTM (commit 26)

Initial plan

334d6a3

Copilot AI assigned Copilot and jcouv Dec 10, 2025

Copilot started work on behalf of jcouv December 10, 2025 03:00 View session

Copilot AI and others added 3 commits December 10, 2025 03:12

Add sourceLink, ruleset, and resources to deterministic key

c3c1c92

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Add tests for sourceLink, ruleset, and resources in deterministic key

7008292

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Fix all test expectations for new deterministic key fields

f8e77cd

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add missing inputs to key file for tracking~~ Track sourceLink, ruleset, and resources in deterministic key Dec 10, 2025

Copilot AI requested a review from jcouv December 10, 2025 03:38

Copilot finished work on behalf of jcouv December 10, 2025 03:38

jcouv added the Area-Compilers label Dec 10, 2025

Copilot started work on behalf of jcouv December 10, 2025 05:00 View session

Remove unused cancellationToken parameter from WriteEmitOptions

08c5f38

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot finished work on behalf of jcouv December 10, 2025 05:07

Copilot started work on behalf of jcouv December 10, 2025 05:21 View session

Remove redundant NullToEmpty calls from GetDeterministicKey caller

e4530d3

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot finished work on behalf of jcouv December 10, 2025 05:27

Simplify

3f972df

Copilot started work on behalf of jcouv December 10, 2025 06:09 View session

Track ruleset content instead of path in deterministic key

2fac371

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Copilot finished work on behalf of jcouv December 10, 2025 06:26

Copilot started work on behalf of jcouv December 10, 2025 06:47 View session

Remove redundant isEmbedded field from resources output

3b9a2f2

Co-authored-by: jcouv <12466233+jcouv@users.noreply.github.com>

Julien Couvreur added 3 commits December 10, 2025 11:30

Use SourceHashAlgorithms.Default

10e34b5

Use SourceText to checksum for resources

77de2ac

Create SourceText for sourceLink late (down in DeterministicKeyBuilder)

c4908f3

jcouv requested review from RikkiGibson and jaredpar December 10, 2025 20:57

jcouv added the Concept-Determinism The issue involves our ability to support determinism in binaries and PDBs created at build time. label Dec 10, 2025

Julien Couvreur added 2 commits December 10, 2025 16:54

Merge remote-tracking branch 'dotnet/main' into copilot/add-missing-i…

9e311f7

…nputs-key-file

Use new feature flag entry

6ee10ab

jaredpar reviewed Dec 12, 2025

View reviewed changes

Compute checksum for streams without using SourceText

c941b90

jcouv requested a review from jaredpar December 17, 2025 07:13

jcouv marked this pull request as draft December 18, 2025 23:40

Julien Couvreur added 4 commits January 12, 2026 15:27

Merge remote-tracking branch 'dotnet/main' into copilot/add-missing-i…

c8a7a28

…nputs-key-file

Add Microsoft.VisualStudio.Extensibility.Testing.Xunit.dll.key to ski…

504439a

…p list

Revert "Add Microsoft.VisualStudio.Extensibility.Testing.Xunit.dll.ke…

dd56447

…y to skip list" This reverts commit 504439a.

Reapply "Add Microsoft.VisualStudio.Extensibility.Testing.Xunit.dll.k…

7b92d7b

…ey to skip list" This reverts commit dd56447.

jcouv marked this pull request as ready for review January 13, 2026 05:23

jcouv requested a review from a team as a code owner January 13, 2026 05:23

jaredpar approved these changes Jan 13, 2026

View reviewed changes

jcouv requested a review from a team January 13, 2026 05:24

AlekseyTs reviewed Jan 13, 2026

View reviewed changes

AlekseyTs approved these changes Jan 13, 2026

View reviewed changes

jcouv merged commit 80e4b60 into main Jan 13, 2026
29 checks passed

jcouv deleted the copilot/add-missing-inputs-key-file branch January 13, 2026 18:35

dotnet-policy-service Bot added this to the Next milestone Jan 13, 2026

dotnet-maestro Bot mentioned this pull request Jan 14, 2026

[main] Source code updates from dotnet/roslyn dotnet/dotnet#4187

Merged

dotnet-bot mentioned this pull request Jan 14, 2026

[Automated] PRs inserted in VS build main-11413.302 #82009

Closed

davidwengier modified the milestones: Next, 18.4 Jan 27, 2026

Conversation

Copilot AI commented Dec 10, 2025 • edited by jcouv Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

jcouv commented Dec 10, 2025

Uh oh!

Copilot AI commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

jcouv commented Dec 10, 2025

Uh oh!

Copilot AI commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

jcouv commented Dec 10, 2025

Uh oh!

Copilot AI commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

jcouv commented Dec 10, 2025

Uh oh!

jaredpar Dec 12, 2025

Choose a reason for hiding this comment

Uh oh!

jcouv commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AlekseyTs Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

jcouv Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

AlekseyTs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Copilot AI commented Dec 10, 2025 •

edited by jcouv

Loading

Copilot AI commented Dec 10, 2025 •

edited

Loading

Copilot AI commented Dec 10, 2025 •

edited

Loading

Copilot AI commented Dec 10, 2025 •

edited

Loading

jcouv commented Dec 19, 2025 •

edited

Loading