Skip to content

docs: align Plugin SDK READMEs with .NET 8 support reality#183

Closed
alafleur-genetec wants to merge 1 commit into
mainfrom
docs/align-plugin-sdk-net8-status
Closed

docs: align Plugin SDK READMEs with .NET 8 support reality#183
alafleur-genetec wants to merge 1 commit into
mainfrom
docs/align-plugin-sdk-net8-status

Conversation

@alafleur-genetec
Copy link
Copy Markdown
Member

This pull request updates documentation to clarify and expand support for .NET 8 and later in the Plugin SDK, including new requirements and guidance for building plugins targeting different runtimes. The most important changes are:

.NET 8 and Plugin SDK Support Updates:

  • Updated the main README.md to indicate that the Plugin SDK now supports .NET 8 for the ServerModule component, provided Security Center 5.13+ is used. The ClientModule continues to require .NET Framework, and a link to detailed guidance has been added.
  • Revised the Plugin SDK sample's README.md to reflect support for .NET Framework 4.8.1, .NET 8 (Security Center 5.13+), and .NET 10 (Security Center 5.14.1+), with clear distinctions between ServerModule and ClientModule targeting requirements.

SDK and Environment Variable Requirements:

  • Clarified that, for builds targeting .NET 8 or later, the GSC_SDK_CORE environment variable is required, and this is available only in Security Center 5.13 or later.

These changes help developers understand the expanded runtime support and updated prerequisites for building plugins with the Plugin SDK.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-only update aligning the top-level README.md and the Plugin SDK sample README.md with the current state of .NET 8 (and .NET 10) support in the Plugin SDK, including the new GSC_SDK_CORE environment-variable requirement and the distinction between ServerModule and ClientModule targeting.

Changes:

  • Updates the SDK Framework Support Matrix row for Plugin SDK to mark .NET 8 as supported, with notes on Security Center 5.13+ and ClientModule constraints.
  • Rewrites the Plugin SDK sample Prerequisites bullet to describe per-module targeting options (.NET Framework 4.8.1, .NET 8, .NET 10) and links to a wiki page.
  • Documents the additional GSC_SDK_CORE environment variable required for .NET 8+ builds.

Reviewed changes

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

File Description
README.md Updates the Plugin SDK row in the framework support matrix to reflect .NET 8 support and module-level constraints.
Samples/Plugin SDK/README.md Expands prerequisites to describe runtime targeting per module and the new GSC_SDK_CORE environment variable.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread Samples/Plugin SDK/README.md Outdated
alafleur-genetec added a commit that referenced this pull request May 15, 2026
Addresses Copilot review on PR #183. The matrix row now shows Plugin
SDK supports .NET 8, but the "Important" note below still claimed "All
other SDK samples target .NET Framework 4.8.1 exclusively" - which
read as a contradiction.

Reframed the note to make explicit it's about how the samples in this
repository are configured (csproj targeting), not about SDK runtime
support (which the matrix above describes). Plugin SDK supports .NET 8
at the SDK level, but the sample csprojs in this repo are not yet
configured to multi-target.
@alafleur-genetec
Copy link
Copy Markdown
Member Author

Closing this PR because its Plugin SDK README/root README changes have been folded into #184. The combined #184 now covers both pieces: removing misleading dead .NET 8 sample project configuration from non-Platform SDK samples, and documenting the actual Plugin SDK runtime support model.

@alafleur-genetec alafleur-genetec deleted the docs/align-plugin-sdk-net8-status branch May 18, 2026 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants