Skip to content

Add DSC resource list to manifest#5997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnMcPMS merged 9 commits into from
Jan 22, 2026
Merged

Add DSC resource list to manifest #5997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6578969
Update schema versions
JohnMcPMS Jan 16, 2026
78b5f4d
Add initial schema iteration
JohnMcPMS Jan 19, 2026
b07a19e
Start adding parsing
JohnMcPMS Jan 19, 2026
2a7d2b1
Merge branch 'master' into dsc-manifest
JohnMcPMS Jan 19, 2026
85aba21
Populator and write completed
JohnMcPMS Jan 19, 2026
bd211dd
Tests largely added, need to debug them
JohnMcPMS Jan 21, 2026
bb90ab1
Test fixes
JohnMcPMS Jan 21, 2026
d0ff888
PR feedback; many comments, changed module regex to match nuget, macr…
JohnMcPMS Jan 22, 2026
c118257
spelling
JohnMcPMS Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/actions/spelling/allow.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,6 +378,7 @@ UNICODESTRING
uninstalling
Unmarshal
unskipped
unstash
untimes
updatefile
updatemanifest
Expand Down
1 change: 1 addition & 0 deletions .github/actions/spelling/expect.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -325,6 +325,7 @@ maxvalue
maybenull
MBH
MBs
mcr
mday
mdmp
mdmpto
Expand Down
6 changes: 3 additions & 3 deletions schemas/JSON/manifests/latest/manifest.defaultLocale.latest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"$id": "https://aka.ms/winget-manifest.defaultlocale.1.12.0.schema.json",
"$id": "https://aka.ms/winget-manifest.defaultlocale.1.28.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A representation of a multiple-file manifest representing a default app metadata in the OWC. v1.12.0",
"description": "A representation of a multiple-file manifest representing a default app metadata in the OWC. v1.28.0",
"definitions": {
"Url": {
"type": [ "string", "null" ],
Expand DownExpand Up@@ -261,7 +261,7 @@
},
"ManifestVersion": {
"type": "string",
"default": "1.12.0",
"default": "1.28.0",
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
"description": "The manifest syntax version"
}
Expand Down
84 changes: 81 additions & 3 deletions schemas/JSON/manifests/latest/manifest.installer.latest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"$id": "https://aka.ms/winget-manifest.installer.1.12.0.schema.json",
"$id": "https://aka.ms/winget-manifest.installer.1.28.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A representation of a single-file manifest representing an app installers in the OWC. v1.12.0",
"description": "A representation of a single-file manifest representing an app installers in the OWC. v1.28.0",
"definitions": {
"PackageIdentifier": {
"type": "string",
Expand DownExpand Up@@ -639,6 +639,78 @@
],
"description": "The authentication requirement for downloading the installer."
},
"DesiredStateConfiguration": {
"type": [ "object", "null" ],
"description": "References to desired state configuration (DSC) resources that are related to the package.",
"properties": {
"PowerShell": {
"type": [ "array", "null" ],
"description": "Contains data about DSC resources that are contained in PowerShell modules.",
"uniqueItems": true,
"maxItems": 16,
"items": {
"type": "object",
"title": "PowerShell DSC Module Item",
"properties": {
"RepositoryUrl": {
"$ref": "#/definitions/Url"
},
"ModuleName": {
"type": "string",
"description": "The name of the module containing resources.",
"$comment": "From nuget package id, although PowerShell convention is slightly more strict: https://learn.microsoft.com/en-us/nuget/reference/errors-and-warnings/nu1017",

@florelisFlor Chacón (florelis)Jan 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: this is not at all important, but I like removing the locale en-us from doc links, so that anybody that opens it gets it in their language automatically.

"pattern": "^\\w+([.-]\\w+)*$",
"maxLength": 100
},
"Resources": {
"type": "array",
"description": "The resources contained within the module.",
"maxItems": 64,
"items": {
"type": "object",
"title": "PowerShell DSC Resource Item",
"properties": {
"Name": {
"type": "string",
"description": "The name of the resource.",
"$comment": "Needs to be an identifier in the various languages (MOF, PS class name), could not find any direct description.",
"pattern": "^[A-Za-z][-_A-Za-z0-9]*$",
"maxLength": 100
}
}
}
}
},
"required": [ "RepositoryUrl", "ModuleName", "Resources" ]
}
},
"DSCv3": {
"type": [ "object", "null" ],
"description": "Contains data about DSC resources that are contained in the package using the DSC v3 specification.",
"properties": {
"Resources": {
"type": "array",
"description": "The resources contained within the package.",
"maxItems": 128,
"items": {
"type": "object",
"title": "DSCv3 Resource Item",
"properties": {
"Type": {
"type": "string",
"description": "The name of the resource.",
"$comment": "Pulled from DSCv3 definition; matches `Publisher.Product.Component/ResourceName` where the Product and Component are optional.",
"pattern": "^\\w+(\\.\\w+){0,2}\\/\\w+$",

@florelisFlor Chacón (florelis)Jan 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: I don't know if we can add comments to these schemas, but I'd appreciate an explanation of what the regex looks for, so that I don't need to parse it next time I read it.

"maxLength": 256
}
}
}
}
},
"required": [ "Resources" ]
}
}
},
"Installer": {
"type": "object",
"properties": {
Expand DownExpand Up@@ -765,6 +837,9 @@
},
"Authentication": {
"$ref": "#/definitions/Authentication"
},
"DesiredStateConfiguration": {
"$ref": "#/definitions/DesiredStateConfiguration"
}
},
"required": [
Expand DownExpand Up@@ -890,6 +965,9 @@
"Authentication": {
"$ref": "#/definitions/Authentication"
},
"DesiredStateConfiguration": {
"$ref": "#/definitions/DesiredStateConfiguration"
},
"Installers": {
"type": "array",
"items": {
Expand All@@ -906,7 +984,7 @@
},
"ManifestVersion": {
"type": "string",
"default": "1.12.0",
"default": "1.28.0",
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
"description": "The manifest syntax version"
}
Expand Down
6 changes: 3 additions & 3 deletions schemas/JSON/manifests/latest/manifest.locale.latest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"$id": "https://aka.ms/winget-manifest.locale.1.12.0.schema.json",
"$id": "https://aka.ms/winget-manifest.locale.1.28.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A representation of a multiple-file manifest representing app metadata in other locale in the OWC. v1.12.0",
"description": "A representation of a multiple-file manifest representing app metadata in other locale in the OWC. v1.28.0",
"definitions": {
"Url": {
"type": [ "string", "null" ],
Expand DownExpand Up@@ -256,7 +256,7 @@
},
"ManifestVersion": {
"type": "string",
"default": "1.12.0",
"default": "1.28.0",
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
"description": "The manifest syntax version"
}
Expand Down
84 changes: 81 additions & 3 deletions schemas/JSON/manifests/latest/manifest.singleton.latest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"$id": "https://aka.ms/winget-manifest.singleton.1.12.0.schema.json",
"$id": "https://aka.ms/winget-manifest.singleton.1.28.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A representation of a single-file manifest representing an app in the OWC. v1.12.0",
"description": "A representation of a single-file manifest representing an app in the OWC. v1.28.0",
"definitions": {
"PackageIdentifier": {
"type": "string",
Expand DownExpand Up@@ -740,6 +740,78 @@
],
"description": "The authentication requirement for downloading the installer."
},
"DesiredStateConfiguration": {
"type": [ "object", "null" ],
"description": "References to desired state configuration (DSC) resources that are related to the package.",
"properties": {
"PowerShell": {
"type": [ "array", "null" ],
"description": "Contains data about DSC resources that are contained in PowerShell modules.",
"uniqueItems": true,
"maxItems": 16,
"items": {
"type": "object",
"title": "PowerShell DSC Module Item",
"properties": {
"RepositoryUrl": {
"$ref": "#/definitions/Url"
},
"ModuleName": {
"type": "string",
"description": "The name of the module containing resources.",
"$comment": "From nuget package id, although PowerShell convention is slightly more strict: https://learn.microsoft.com/en-us/nuget/reference/errors-and-warnings/nu1017",
"pattern": "^\\w+([.-]\\w+)*$",
"maxLength": 100
},
"Resources": {
"type": "array",
"description": "The resources contained within the module.",
"maxItems": 64,
"items": {
"type": "object",
"title": "PowerShell DSC Resource Item",
"properties": {
"Name": {
"type": "string",
"description": "The name of the resource.",
"$comment": "Needs to be an identifier in the various languages (MOF, PS class name), could not find any direct description.",
"pattern": "^[A-Za-z][-_A-Za-z0-9]*$",
"maxLength": 100
}
}
}
}
},
"required": [ "RepositoryUrl", "ModuleName", "Resources" ]
}
},
"DSCv3": {
"type": [ "object", "null" ],
"description": "Contains data about DSC resources that are contained in the package using the DSC v3 specification.",
"properties": {
"Resources": {
"type": "array",
"description": "The resources contained within the package.",
"maxItems": 128,
"items": {
"type": "object",
"title": "DSCv3 Resource Item",
"properties": {
"Type": {
"type": "string",
"description": "The name of the resource.",
"$comment": "Pulled from DSCv3 definition; matches `Publisher.Product.Component/ResourceName` where the Product and Component are optional.",
"pattern": "^\\w+(\\.\\w+){0,2}\\/\\w+$",
"maxLength": 256
}
}
}
}
},
"required": [ "Resources" ]
}
}
},
"Installer": {
"type": "object",
"properties": {
Expand DownExpand Up@@ -866,6 +938,9 @@
},
"Authentication": {
"$ref": "#/definitions/Authentication"
},
"DesiredStateConfiguration": {
"$ref": "#/definitions/DesiredStateConfiguration"
}
},
"required": [
Expand DownExpand Up@@ -1114,6 +1189,9 @@
"Authentication": {
"$ref": "#/definitions/Authentication"
},
"DesiredStateConfiguration": {
"$ref": "#/definitions/DesiredStateConfiguration"
},
"Installers": {
"type": "array",
"items": {
Expand All@@ -1130,7 +1208,7 @@
},
"ManifestVersion": {
"type": "string",
"default": "1.12.0",
"default": "1.28.0",
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
"description": "The manifest syntax version"
}
Expand Down
6 changes: 3 additions & 3 deletions schemas/JSON/manifests/latest/manifest.version.latest.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"$id": "https://aka.ms/winget-manifest.version.1.12.0.schema.json",
"$id": "https://aka.ms/winget-manifest.version.1.28.0.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "A representation of a multi-file manifest representing an app version in the OWC. v1.12.0",
"description": "A representation of a multi-file manifest representing an app version in the OWC. v1.28.0",
"type": "object",
"properties": {
"PackageIdentifier": {
Expand DownExpand Up@@ -31,7 +31,7 @@
},
"ManifestVersion": {
"type": "string",
"default": "1.12.0",
"default": "1.28.0",
"pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){2}$",
"description": "The manifest syntax version"
}
Expand Down
18 changes: 18 additions & 0 deletions src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1055,6 +1055,24 @@
<CopyFileToFolders Include="TestData\Manifest-MSIX-in-Archive.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\ManifestV1_28-Singleton.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-DefaultLocale.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-Installer.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-Locale.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-Version.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\ManifestV1_28-PowerShellDSC.yaml">
<DeploymentContent>true</DeploymentContent>
</CopyFileToFolders>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\AppInstallerCLICore\AppInstallerCLICore.vcxproj">
Expand Down
27 changes: 27 additions & 0 deletions src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,9 @@
<Filter Include="TestData\Shadow\V1_5">
<UniqueIdentifier>{6bd68492-3f96-4023-af35-63249cd18158}</UniqueIdentifier>
</Filter>
<Filter Include="TestData\MultiFileManifestV1_28">
<UniqueIdentifier>{0e5f9ff4-6f22-46eb-8538-1c560a008f06}</UniqueIdentifier>
</Filter>
</ItemGroup>
<ItemGroup>
<ClInclude Include="pch.h">
Expand DownExpand Up@@ -1113,5 +1116,29 @@
<CopyFileToFolders Include="TestData\TestFont.ttf">
<Filter>TestData</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-DefaultLocale.yaml">
<Filter>TestData\MultiFileManifestV1_28</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-Installer.yaml">
<Filter>TestData\MultiFileManifestV1_28</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-Locale.yaml">
<Filter>TestData\MultiFileManifestV1_28</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\MultiFileManifestV1_28\ManifestV1_28-MultiFile-Version.yaml">
<Filter>TestData\MultiFileManifestV1_28</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\Manifest-MSIX-in-AppsAndFeatures.yaml">
<Filter>TestData</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\Manifest-MSIX-in-Archive.yaml">
<Filter>TestData</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\ManifestV1_28-PowerShellDSC.yaml">
<Filter>TestData</Filter>
</CopyFileToFolders>
<CopyFileToFolders Include="TestData\ManifestV1_28-Singleton.yaml">
<Filter>TestData</Filter>
</CopyFileToFolders>
</ItemGroup>
</Project>
Loading