Initial support for DSC v3 in WinGet-Create #607

AmelBawa-msft · 2025-06-12T23:09:06Z

⚙️ Settings DSC resource

📄 Get

PS C:\> wingetcreate dsc settings --get
{"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"A","name":"B"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}}}

🖨️ Export

ℹ️ Settings resource Get and Export operation output states are identical.

PS C:\> wingetcreate dsc settings --export
{"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"A","name":"B"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}}}

📝 Set

Action Full: When action is set to Full, the specified settings will be update accordingly and the remaining settings will be set to their default values.
Action Partial: When action is set to Partial, only the specified settings will be updated, and the remaining settings will remain unchanged.

🌕 Full

PS C:\> wingetcreate dsc settings --set '{"settings": { "Telemetry": { "disable": false }}, "action": "Full"}'
{"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":false},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Full"}
["settings"]

🌗 Partial

PS C:\> wingetcreate dsc settings --set '{"settings": { "Telemetry": { "disable": true }}, "action": "Partial"}'
{"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Partial"}
["settings"]

🧪 Test

Action Full: When action is set to Full, the specified settings will be tested accordingly, and the remaining settings will be tested against their default values.
Action Partial: When action is set to Partial, only the specified settings will be tested, and the remaining settings will be omitted from the test.

🌕 Full

PS C:\> wingetcreate dsc settings --test '{"settings": { "Telemetry": { "disable": false }}, "action": "Full"}'
{"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Full","_inDesiredState":false}
["settings"]

🌗 Partial

PS C:\> wingetcreate dsc settings --test '{"settings": { "Telemetry": { "disable": false }}, "action": "Partial"}'
{"settings":{"$schema":"https://aka.ms/wingetcreate-settings.schema.0.1.json","Telemetry":{"disable":true},"CleanUp":{"intervalInDays":7,"disable":false},"WindowsPackageManagerRepository":{"owner":"microsoft","name":"winget-pkgs"},"Manifest":{"format":"yaml"},"Visual":{"anonymizePaths":true}},"action":"Partial","_inDesiredState":false}
["settings"]

…o user/amelbawa/dsc

src/WingetCreateCLI/Commands/DscCommand.cs

src/WingetCreateCLI/Commands/BaseCommand.cs

src/WingetCreateCLI/Properties/Resources.resx

src/WingetCreateCLI/Models/DscModels/SettingsResourceObject.cs

src/WingetCreateCLI/DscResources/microsoft.winget-create.settings.dsc.resource.json

AmelBawa-msft · 2025-06-16T16:53:37Z

/azp run

azure-pipelines · 2025-06-16T16:53:47Z

Azure Pipelines successfully started running 1 pipeline(s).

AmelBawa-msft · 2025-06-16T22:56:43Z

/azp run

azure-pipelines · 2025-06-16T22:56:54Z

Azure Pipelines successfully started running 1 pipeline(s).

mdanish-kh

This looks great!

(P.S. maybe you can modify the PR description for the new changes to command syntax to help others who will review this PR :D)

src/WingetCreateTests/WingetCreateTests/UnitTests/DscCommandTests.cs

AmelBawa-msft · 2025-06-17T15:43:27Z

/azp run

azure-pipelines · 2025-06-17T15:43:37Z

Azure Pipelines successfully started running 1 pipeline(s).

mdanish-kh · 2025-06-19T08:57:36Z

We may also want to update the README and also the doc folder for the new dsc command

winget-create/README.md

Lines 43 to 57 in f26390d

    
           **WingetCreate** has the following commands: 
        
           | Command  | Description | 
        
           | -------  | ----------- | 
        
           | [New](doc/new.md)      | Command for creating a new manifest from scratch | 
        
           | [Update](doc/update.md)  | Command for updating an existing manifest | 
        
           | [New-Locale](doc/new-locale.md)  | Command for creating a new locale for an existing manifest | 
        
           | [Update-Locale](doc/update-locale.md)  | Command for updating a locale for an existing manifest | 
        
           | [Submit](doc/submit.md)  | Command for submitting an existing PR  | 
        
           | [Show](doc/show.md)      | Command for displaying existing manifests  | 
        
           | [Token](doc/token.md)   | Command for managing cached GitHub personal access tokens | 
        
           | [Settings](doc/settings.md) | Command for editing the settings file configurations | 
        
           | [Cache](doc/cache.md) | Command for managing downloaded installers stored in cache 
        
           | [Info](doc/info.md)      | Displays information about the client | 
        
           | [-?](doc/help.md)      | Displays command line help |

mdanish-kh

thanks for the docs and bearing with me :D

doc/dsc/settings.md

doc/dsc.md

src/WingetCreateCLI/WingetCreateCLI.csproj

src/WingetCreateCLI/Commands/DscCommand.cs

src/WingetCreateCLI/Models/DscModels/BaseResourceObject.cs

src/WingetCreateCLI/Models/DscModels/SettingsFunctionData.cs

src/WingetCreateCLI/Models/DscModels/SettingsResourceObject.cs

yao-msft · 2025-06-22T05:59:49Z

/azp run

azure-pipelines · 2025-06-22T05:59:59Z

Azure Pipelines successfully started running 1 pipeline(s).

src/WingetCreateCLI/Models/DscModels/SettingsFunctionData.cs

AmelBawa-msft · 2025-06-24T23:15:18Z

/azp run

azure-pipelines · 2025-06-24T23:15:28Z

Azure Pipelines successfully started running 1 pipeline(s).

src/WingetCreatePackage/WingetCreatePackage.wapproj

src/WingetCreatePackage/Package.appxmanifest

AmelBawa-msft · 2025-06-25T22:20:08Z

/azp run

azure-pipelines · 2025-06-25T22:20:19Z

Azure Pipelines successfully started running 1 pipeline(s).

AmelBawa-msft added 11 commits June 10, 2025 13:10

WIP

4e4d3c0

Merge branch 'main' of https://github.com/microsoft/winget-create int…

cc4a510

…o user/amelbawa/dsc

Init draft

f10d9bb

Move files

9113d1e

Added schema

bc9cd4a

Init resource file

956357f

Resx

65b30f4

Fix resource file

888ec82

Resx

26d5054

Fix resource file

c1b6c87

Adding UT

8035d57

mdanish-kh reviewed Jun 16, 2025

View reviewed changes

Adding more UT

12b66f4

AmelBawa-msft marked this pull request as ready for review June 16, 2025 16:35

AmelBawa-msft added 3 commits June 16, 2025 11:00

Assert InDesiredState for Test operation

bc41cde

Addressed comments

0e71f5a

Addressed comments

f44e819

AmelBawa-msft requested a review from mdanish-kh June 16, 2025 23:06

mdanish-kh reviewed Jun 17, 2025

View reviewed changes

src/WingetCreateTests/WingetCreateTests/UnitTests/DscCommandTests.cs Outdated Show resolved Hide resolved

src/WingetCreateTests/WingetCreateTests/UnitTests/DscCommandTests.cs Outdated Show resolved Hide resolved

AmelBawa-msft added 2 commits June 17, 2025 08:37

Addressed comments

617ec32

Addressed comments

15e6ffb

Fix resource file

e8d496e

Adding docs

d968ed7

No wrap

43fbd1d

mdanish-kh reviewed Jun 20, 2025

View reviewed changes

doc/dsc/settings.md Show resolved Hide resolved

doc/dsc.md Outdated Show resolved Hide resolved

mdanish-kh approved these changes Jun 20, 2025

View reviewed changes

yao-msft reviewed Jun 22, 2025

View reviewed changes

src/WingetCreateCLI/Models/DscModels/SettingsFunctionData.cs Outdated Show resolved Hide resolved

AmelBawa-msft added 4 commits June 23, 2025 12:24

Typo

5180d13

Resolved conflicts

02e0d6b

Update version

c6f0da2

Addressed comments

90753de

yao-msft reviewed Jun 25, 2025

View reviewed changes

src/WingetCreatePackage/WingetCreatePackage.wapproj Outdated Show resolved Hide resolved

yao-msft reviewed Jun 25, 2025

View reviewed changes

src/WingetCreatePackage/Package.appxmanifest Outdated Show resolved Hide resolved

AmelBawa-msft added 2 commits June 25, 2025 14:10

Addressed comments

5d35f41

Addressed comments

f38aa7d

AmelBawa-msft enabled auto-merge (squash) June 25, 2025 22:39

yao-msft approved these changes Jun 25, 2025

View reviewed changes

AmelBawa-msft merged commit ca5f445 into main Jun 25, 2025
5 checks passed

AmelBawa-msft deleted the user/amelbawa/dsc branch June 25, 2025 23:06

AmelBawa-msft linked an issue Jul 9, 2025 that may be closed by this pull request

Implement support for settings via DSC #602

Closed

Initial support for DSC v3 in WinGet-Create #607

Initial support for DSC v3 in WinGet-Create #607

Uh oh!

Conversation

AmelBawa-msft commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚙️ Settings DSC resource

📄 Get

🖨️ Export

📝 Set

🌕 Full

🌗 Partial

🧪 Test

🌕 Full

🌗 Partial

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AmelBawa-msft commented Jun 16, 2025

Uh oh!

azure-pipelines bot commented Jun 16, 2025

Uh oh!

AmelBawa-msft commented Jun 16, 2025

Uh oh!

azure-pipelines bot commented Jun 16, 2025

Uh oh!

mdanish-kh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AmelBawa-msft commented Jun 17, 2025

Uh oh!

azure-pipelines bot commented Jun 17, 2025

Uh oh!

mdanish-kh commented Jun 19, 2025

Uh oh!

mdanish-kh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yao-msft commented Jun 22, 2025

Uh oh!

azure-pipelines bot commented Jun 22, 2025

Uh oh!

Uh oh!

AmelBawa-msft commented Jun 24, 2025

Uh oh!

azure-pipelines bot commented Jun 24, 2025

Uh oh!

Uh oh!

Uh oh!

AmelBawa-msft commented Jun 25, 2025

Uh oh!

azure-pipelines bot commented Jun 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AmelBawa-msft commented Jun 12, 2025 •

edited

Loading