Skip to content

Commit 5012a2d

Browse files
authored
New WinGet file convention (#5194)
1 parent 4397ee3 commit 5012a2d

File tree

2 files changed

+3
-8
lines changed

2 files changed

+3
-8
lines changed

hub/package-manager/configuration/create.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Windows Package Manager uses manifests (YAML files) to locate and install packag
2424

2525
### File naming convention
2626

27-
The convention for naming a WinGet Configuration file is `configuration.dsc.yaml`. For Git-based projects the default configuration should be stored in a "configurations" directory at: `./configurations/configuration.dsc.yaml`.
27+
The convention for naming a WinGet Configuration file is using the ".winget" file extension (like `configuration.winget`). For Git-based projects the default configuration should be stored in a ".config" directory at: `./config/configuration.winget`. In some cases, more than one configuration file may be appropriate given different toolchains or user preferences. Those additional configuration files should also be located in the ".config" directory.
2828

2929
### Sections of a WinGet Configuration file
3030

@@ -49,7 +49,7 @@ The list of Resources covers all of the software, tools, packages, etc. that nee
4949

5050
## Example WinGet Configuration file
5151

52-
The following is an example WinGet Configuration `configuration.dsc.yaml` formatted file:
52+
The following is an example WinGet Configuration `configuration.winget` formatted file:
5353

5454
```yml
5555
# yaml-language-server: $schema=https://aka.ms/configuration-dsc-schema/0.2
@@ -72,7 +72,6 @@ properties:
7272
id: vsPackage
7373
directives:
7474
description: Install Visual Studio 2022 Community
75-
allowPrerelease: true
7675
settings:
7776
id: Microsoft.VisualStudio.2022.Community
7877
source: winget

hub/package-manager/configuration/index.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ We recommend ALWAYS validating the integrity of a WinGet Configuration file befo
7777

7878
### Where can I find sample WinGet Configuration files?
7979

80-
You can find sample WinGet Configuration files in the Windows Dev Home repo: [https://aka.ms/dsc.yaml](https://aka.ms/dsc.yaml).
80+
You can find sample WinGet Configuration files in the WinGet DSC repository: [https://aka.ms/dsc.yaml](https://aka.ms/dsc.yaml).
8181

8282
### Where can I find examples of PowerShell modules containing DSC resources?
8383

@@ -89,10 +89,6 @@ The [PowerShell Gallery](https://www.powershellgallery.com/packages) hosts hundr
8989

9090
Yes. [Group Policy Objects](/microsoft-365/compliance/device-onboarding-gp) **EnableWindowsPackageManagerConfiguration** and **EnableWindowsPackageManagerConfigurationExplanation** can be utilized for disabling WinGet Configuration feature in your organization.
9191

92-
### Where can I learn more about using WinGet Configurations with Dev Home and Dev Drives?
93-
94-
Learn more about using the Machine Configuration tool in Windows 11 Dev Home in the article [Set up your Windows development environment with Dev Home](/windows/dev-home/setup). You may also be interested in learning how to use the more performance optimized Dev Drive storage volumes, see [Set up a Dev Drive on Windows 11](/windows/dev-drive/).
95-
9692
## Troubleshooting WinGet Configurations
9793

9894
The most common reason for a WinGet Configuration to fail is due to a PowerShell DSC resource requiring administrative access to apply the desired state. Not all DSC resources surface explicit reasons for failure.

0 commit comments

Comments
 (0)