docs: align Plugin SDK READMEs with .NET 8 support reality#183
Open
alafleur-genetec wants to merge 3 commits into
Open
docs: align Plugin SDK READMEs with .NET 8 support reality#183alafleur-genetec wants to merge 3 commits into
alafleur-genetec wants to merge 3 commits into
Conversation
The Plugin SDK README and the root README's Framework Support Matrix
both claimed Plugin SDK does not support .NET 8 ("planned for future
release"). That has been outdated since Security Center 5.13, which
added .NET 8 support for role plugins.
Authoritative source: the DAP wiki page
https://github.com/Genetec/DAP/wiki/plugin-sdk-net8
Updates:
- Samples/Plugin SDK/README.md: Prerequisites bullet now describes
the actual rule: ServerModule can target .NET Framework 4.8 (any SC
version), .NET 8 (SC 5.13+), or .NET 10 (SC 5.14.1+); ClientModule
remains .NET Framework only because Config Tool / Security Desk run
on .NET Framework. Also notes the GSC_SDK_CORE env var requirement
for .NET 8+ builds.
- README.md: Framework Support Matrix Plugin SDK row updated from
"❌ planned for future release" to "✅ requires Security Center 5.13+",
with a note about the ClientModule remaining .NET Framework. Both
entries link to the wiki for project-structure details.
The "Important" note below the matrix remains accurate: it describes
sample-csproj multi-targeting in this repo (Platform SDK samples are
multi-targeted; Plugin / Workspace / Media SDK samples currently target
net481 only). Enabling .NET 8 in the Plugin SDK sample csprojs is a
separate task.
Contributor
There was a problem hiding this comment.
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
ClientModuleconstraints. - 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_COREenvironment 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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
README.mdto indicate that the Plugin SDK now supports .NET 8 for theServerModulecomponent, provided Security Center 5.13+ is used. TheClientModulecontinues to require .NET Framework, and a link to detailed guidance has been added.README.mdto 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 betweenServerModuleandClientModuletargeting requirements.SDK and Environment Variable Requirements:
GSC_SDK_COREenvironment 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.