Add adapted resource manifest for each module#262
Open
Gijsreyn wants to merge 6 commits intomicrosoft:mainfrom
Open
Add adapted resource manifest for each module#262Gijsreyn wants to merge 6 commits intomicrosoft:mainfrom
Gijsreyn wants to merge 6 commits intomicrosoft:mainfrom
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
…crosoftgh-261/main/add-adapted-manifests
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds DSC v3 adapted resource manifests alongside each PowerShell DSC module and fills in missing comment-based help (.SYNOPSIS / parameters) so dsc.exe can discover resources faster via adapted manifests.
Changes:
- Add
*.dsc.manifests.jsonadapted resource manifest files to each module underresources/. - Add/expand comment-based help for DSC resources across multiple modules.
- Update check-spelling expected word lists for newly introduced terms.
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| resources/YarnDsc/yarndsc.dsc.manifests.json | Adds adapted resource manifest for YarnDsc. |
| resources/YarnDsc/YarnDsc.psm1 | Adds comment-based help for YarnInstall. |
| resources/RustDsc/rustdsc.dsc.manifests.json | Adds adapted resource manifest for RustDsc. |
| resources/RustDsc/RustDsc.psm1 | Adds missing parameter help text (InstalledVersion). |
| resources/PythonPip3Dsc/pythonpip3dsc.dsc.manifests.json | Adds adapted resource manifest for PythonPip3Dsc. |
| resources/PythonPip3Dsc/PythonPip3Dsc.psm1 | Adds missing parameter help text (PackageName). |
| resources/NpmDsc/npmdsc.dsc.manifests.json | Adds adapted resource manifest for NpmDsc (two resources). |
| resources/NpmDsc/NpmDsc.psm1 | Minor formatting + adds comment-based help for NpmInstall and parameter docs for NpmPackage. |
| resources/Microsoft.WindowsSandbox.DSC/microsoftwindowssandboxdsc.dsc.manifests.json | Adds adapted resource manifest for WindowsSandbox module. |
| resources/Microsoft.WindowsSandbox.DSC/Microsoft.WindowsSandbox.DSC.psm1 | Adds comment-based help for WindowsSandbox. |
| resources/Microsoft.Windows.Settings/microsoftwindowssettings.dsc.manifests.json | Adds adapted resource manifest for WindowsSettings module. |
| resources/Microsoft.Windows.Settings/Microsoft.Windows.Settings.psm1 | Adds comment-based help for WindowsSettings + whitespace fixes. |
| resources/Microsoft.Windows.Setting.Accessibility/microsoftwindowssettingaccessibility.dsc.manifests.json | Adds adapted resource manifest for Accessibility module (multiple resources). |
| resources/Microsoft.Windows.Setting.Accessibility/Microsoft.Windows.Setting.Accessibility.psm1 | Adds comment-based help for multiple accessibility resources. |
| resources/Microsoft.Windows.Developer/microsoftwindowsdeveloper.dsc.manifests.json | Adds adapted resource manifest for Developer module (multiple resources). |
| resources/Microsoft.Windows.Developer/Microsoft.Windows.Developer.psm1 | Adds comment-based help for multiple developer resources + minor formatting. |
| resources/Microsoft.VSCode.Dsc/microsoftvscodedsc.dsc.manifests.json | Adds adapted resource manifest for VS Code DSC module. |
| resources/Microsoft.DotNet.Dsc/microsoftdotnetdsc.dsc.manifests.json | Adds adapted resource manifest for .NET DSC module. |
| .github/actions/spelling/expect/windows_terms.txt | Adds expected Windows-related terms for spelling CI. |
| .github/actions/spelling/expect/usernames.txt | Adds expected usernames for spelling CI. |
| .github/actions/spelling/expect/software.txt | Adds expected software-related terms for spelling CI. |
| .github/actions/spelling/expect/generic_terms.txt | Adds expected generic terms for spelling CI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 adds missing
SYNOPSISand includes a.*dsc.manifests.jsonfile in the root of each module. When modules gets published, these should/are published alongside, allowingdsc.exeto discover them throughpowershell.discover.ps1.The script that I used to generate the adapted resource manifests:
Fixes #261
Note
Currently, there's no shipped version with PR . It's possible to split them up and use the
*.dsc.adaptedresource.jsonconvention.