Add HelpLinkUri to Roslyn analyzer diagnostics

[Copilot]

Roslyn analyzer diagnostics lacked help links, making it harder for users to understand code constraint violations.

Changes

Added helpLinkUri parameter to all 15 DiagnosticDescriptor instances across 13 analyzer files:

static readonly DiagnosticDescriptor Rule = new(
    DiagnosticId,
    Title,
    MessageFormat,
    AnalyzersCategories.Orchestration,
    DiagnosticSeverity.Warning,
    isEnabledByDefault: true,
    helpLinkUri: "https://go.microsoft.com/fwlink/?linkid=2346202");

Links point to Durable Functions code constraints documentation using a centralized go.microsoft.com redirect link for easier management.

Diagnostics updated:

• DURABLE0001-0008: Orchestration analyzers (DateTime, Guid, Delay, Thread/Task, I/O, Environment, CancellationToken, other bindings)
• DURABLE1001-1003: Attribute binding analyzers (OrchestrationTrigger, DurableClient, EntityTrigger)
• DURABLE2001-2004: Activity analyzers (input/output type matching, function not found)

Added DiagnosticDescriptorTests to validate HelpLinkUri presence and format for all analyzers.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Include HelpLinkUri in Roslyn analyzer diagnostics</issue_title>
<issue_description>We can add a generic link to https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-code-constraints?tabs=csharp, or preferably we can direct to the specific diagnostic page, like Functions team did: https://github.com/Azure/azure-functions-host/blob/d1067c54b27a8bb491867d692c9f7154f50552b8/src/WebJobs.Script.Analyzers/DiagnosticDescriptors.cs#L12</issue_description>

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

• Fixes Include HelpLinkUri in Roslyn analyzer diagnostics #329

---

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

[YunchuWang]

@copilot update helplink to this https://go.microsoft.com/fwlink/?linkid=2346202

[Copilot]

Pull request overview

This PR adds help link URIs to all Roslyn analyzer diagnostic descriptors, making it easier for users to understand code constraint violations by providing direct links to relevant documentation. The change systematically updates 15 diagnostic descriptors across 13 analyzer files and adds comprehensive test coverage to ensure all diagnostics have properly formatted help links.

Key Changes

• Added helpLinkUri parameter to all DiagnosticDescriptor instantiations pointing to Microsoft Learn documentation with diagnostic-specific anchors
• Created DiagnosticDescriptorTests class with parameterized test to validate help link presence and format across all analyzers
• Help links follow the pattern: https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-code-constraints?tabs=csharp#{DiagnosticId}

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
test/Analyzers.Tests/DiagnosticDescriptorTests.cs	New test file that validates all diagnostic descriptors have properly formatted help links
src/Analyzers/Orchestration/ThreadTaskOrchestrationAnalyzer.cs	Added help link to DURABLE0004 diagnostic
src/Analyzers/Orchestration/IOOrchestrationAnalyzer.cs	Added help link to DURABLE0005 diagnostic
src/Analyzers/Orchestration/GuidOrchestrationAnalyzer.cs	Added help link to DURABLE0002 diagnostic
src/Analyzers/Orchestration/EnvironmentOrchestrationAnalyzer.cs	Added help link to DURABLE0006 diagnostic
src/Analyzers/Orchestration/DelayOrchestrationAnalyzer.cs	Added help link to DURABLE0003 diagnostic
src/Analyzers/Orchestration/DateTimeOrchestrationAnalyzer.cs	Added help link to DURABLE0001 diagnostic
src/Analyzers/Functions/Orchestration/OtherBindingsOrchestrationAnalyzer.cs	Added help link to DURABLE0008 diagnostic
src/Analyzers/Functions/Orchestration/CancellationTokenOrchestrationAnalyzer.cs	Added help link to DURABLE0007 diagnostic
src/Analyzers/Functions/AttributeBinding/OrchestrationTriggerBindingAnalyzer.cs	Added help link to DURABLE1001 diagnostic
src/Analyzers/Functions/AttributeBinding/EntityTriggerBindingAnalyzer.cs	Added help link to DURABLE1003 diagnostic
src/Analyzers/Functions/AttributeBinding/DurableClientBindingAnalyzer.cs	Added help link to DURABLE1002 diagnostic
src/Analyzers/Activities/MatchingInputOutputTypeActivityAnalyzer.cs	Added help links to DURABLE2001 and DURABLE2002 diagnostics
src/Analyzers/Activities/FunctionNotFoundAnalyzer.cs	Added help links to DURABLE2003 and DURABLE2004 diagnostics

[YunchuWang]

@copilot update all links to this link instead https://go.microsoft.com/fwlink/?linkid=2346202, we need to use this link

[Copilot]

@copilot update helplink to this https://go.microsoft.com/fwlink/?linkid=2346202

Updated all HelpLinkUri values to use https://go.microsoft.com/fwlink/?linkid=2346202 in commit 5bcc25e.

[Copilot]

@copilot update all links to this link instead https://go.microsoft.com/fwlink/?linkid=2346202, we need to use this link

This change was already completed in commit 5bcc25e. All HelpLinkUri values now use https://go.microsoft.com/fwlink/?linkid=2346202.

[YunchuWang]

@copilot update pr description to follow .github/PULL_REQUEST_TEMPLATE.md

[Copilot]

@copilot update pr description to follow .github/PULL_REQUEST_TEMPLATE.md

Here's the updated PR description following the template:

---

Summary

What changed?

• Added helpLinkUri parameter to all 15 DiagnosticDescriptor instances across 13 analyzer files
• All help links now point to https://go.microsoft.com/fwlink/?linkid=2346202 (centralized redirect to Durable Functions code constraints documentation)
• Created DiagnosticDescriptorTests class to validate HelpLinkUri presence and format for all analyzers

Why is this change needed?

Roslyn analyzer diagnostics lacked help links, making it harder for users to understand code constraint violations. Adding help links provides direct access to documentation explaining the constraints and how to resolve violations.

Issues / work items

• Resolves the request to include HelpLinkUri in Roslyn analyzer diagnostics

---

Project checklist

• Release notes are not required for the next release
• Backport is not required
• All required tests have been added/updated (unit tests, E2E tests)
• Breaking change? No

---

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

• No
• Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
• Yes, an AI agent generated most of this PR

If AI was used:

• Tool(s): GitHub Copilot Workspace Agent
• AI-assisted areas/files: All 13 analyzer files and the test file
• What you changed after AI output: Updated HelpLinkUri from long Microsoft Learn URL to go.microsoft.com redirect link per reviewer feedback

AI verification (required if AI was used):

• I understand the code and can explain it
• I verified referenced APIs/types exist and are correct
• I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
• I reviewed concurrency/async behavior
• I checked for unintended breaking or behavior changes

---

Testing

Automated tests

• Result: Passed (All 107 tests pass including 13 new tests for HelpLinkUri validation)

Manual validation (only if runtime/behavior changed)

• N/A (Analyzer metadata change only, no runtime behavior change)

---

Notes for reviewers

Diagnostics updated:

• DURABLE0001-0008: Orchestration analyzers (DateTime, Guid, Delay, Thread/Task, I/O, Environment, CancellationToken, other bindings)
• DURABLE1001-1003: Attribute binding analyzers (OrchestrationTrigger, DurableClient, EntityTrigger)
• DURABLE2001-2004: Activity analyzers (input/output type matching, function not found)

The help link uses a go.microsoft.com redirect for easier future management of the target documentation URL.

[YunchuWang]

cant find where is helplink in visual studio for any diagnostic? is it not showing in visual studio at all?

[YunchuWang]

https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.diagnosticdescriptor?view=roslyn-dotnet-4.9.0 the change LGTM though