Skip to content

Add adapted resource manifest for each module#262

Open
Gijsreyn wants to merge 6 commits intomicrosoft:mainfrom
Gijsreyn:gh-261/main/add-adapted-manifests
Open

Add adapted resource manifest for each module#262
Gijsreyn wants to merge 6 commits intomicrosoft:mainfrom
Gijsreyn:gh-261/main/add-adapted-manifests

Conversation

@Gijsreyn
Copy link
Copy Markdown
Contributor

@Gijsreyn Gijsreyn commented May 1, 2026


This pull request adds missing SYNOPSIS and includes a .*dsc.manifests.json file in the root of each module. When modules gets published, these should/are published alongside, allowing dsc.exe to discover them through powershell.discover.ps1.

The script that I used to generate the adapted resource manifests:

foreach ($resource in (Get-ChildItem -Path C:\source\winget-dsc\resources\* -Filter *.psm1 -Recurse)) {
    $root = Split-Path -Path $resource.FullName -Parent
    $moduleName = (Split-Path -Path $resource.FullName -Leaf).Replace('.psm1', '.dsc.manifests.json').ToLower()

    New-DscAdaptedResourceManifest -Path $resource.FullName |
    New-DscResourceManifest |
    ForEach-Object { $_.ToJson() } |
    Set-Content -Path (Join-Path -Path $root -ChildPath $moduleName)
}

Fixes #261

Note

Currently, there's no shipped version with PR . It's possible to split them up and use the *.dsc.adaptedresource.json convention.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

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

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.json adapted resource manifest files to each module under resources/.
  • 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.

Comment thread resources/RustDsc/rustdsc.dsc.manifests.json Outdated
Comment thread resources/RustDsc/rustdsc.dsc.manifests.json Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ship adapted resource manifest alongside module

2 participants