Skip to content

Commit b79d2a1

Browse files
authored
Merge pull request #4642 from mdanish-kh/makeConfigurationStable
Make WinGet Configuration a stable feature in docs
2 parents 9600154 + 3f9d2ff commit b79d2a1

File tree

4 files changed

+16
-40
lines changed

4 files changed

+16
-40
lines changed

hub/package-manager/configuration/check.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: How to check a WinGet Configuration
3-
description: Learn how to check a WinGet Configuration.
4-
ms.date: 05/23/2023
3+
description: Learn how to check a WinGet Configuration.
4+
ms.date: 09/28/2023
55
ms.topic: overview
66
---
77

88
# How to check the trustworthiness of a WinGet Configuration file
99

1010
Prior to running a WinGet Configuration file, it is recommended to review and evaluate each resource listed in the file, ensuring that you are fully aware of what is being installed, changed, or applied to your operating system, and that it is coming from a credible and secure source.
1111

12-
> [!IMPORTANT]
13-
> WinGet Configuration is currently in preview. To use a WinGet Configuration file with the [`winget configure` command](../winget/configure.md), you must first [enable the experimental configuration feature](index.md#enable-the-winget-configuration-experimental-configuration-preview-feature).
12+
Learn more about using the [WinGet configure command](/windows/package-manager/winget/configure).
1413

1514
## Security notifications and approvals
1615

hub/package-manager/configuration/create.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: How to author a WinGet Configuration file
3-
description: Learn how to create a WinGet Configuration.
4-
ms.date: 05/23/2023
3+
description: Learn how to create a WinGet Configuration.
4+
ms.date: 09/28/2023
55
ms.topic: overview
66
---
77

@@ -16,12 +16,11 @@ To create a WinGet Configuration file:
1616
5. Determine the directives and settings needed for each configuration resource.
1717
6. Determine the dependencies for each resource.
1818

19-
> [!IMPORTANT]
20-
> WinGet Configuration is currently in preview. To use a WinGet Configuration file with the [`winget configure` command](../winget/configure.md), you must first [enable the experimental configuration feature](index.md#enable-the-winget-configuration-experimental-configuration-preview-feature).
19+
Learn more about using the [WinGet configure command](/windows/package-manager/winget/configure).
2120

2221
## File format
2322

24-
Windows Package Manager uses manifests (YAML files) to locate and install packages for Windows users. WinGet Configuration files use the same YAML style format, adding a JSON schema specification to help define the structure and validation of the file. To further assist in detecting whether the format of your WinGet Configuration file is valid, we recomend using [Visual Studio Code](https://code.visualstudio.com/download) with the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by RedHat to support proper syntax, help detect any formatting errors, provide hover support and auto-completion (when linked to the JSON schema file), and ensure valid formatting.
23+
Windows Package Manager uses manifests (YAML files) to locate and install packages for Windows users. WinGet Configuration files use the same YAML style format, adding a JSON schema specification to help define the structure and validation of the file. To further assist in detecting whether the format of your WinGet Configuration file is valid, we recommend using [Visual Studio Code](https://code.visualstudio.com/download) with the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by RedHat to support proper syntax, help detect any formatting errors, provide hover support and auto-completion (when linked to the JSON schema file), and ensure valid formatting.
2524

2625
### File naming convention
2726

hub/package-manager/configuration/index.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: WinGet Configuration
3-
description: WinGet Configuration uses the winget configure command, PowerShell, and a YAML-formatted configuration file listing all of the software versions, packages, tools, and settings required to achieve the set up the desired state of the development environment on your Windows machine. Minimizing manual project setup and onboarding to a single command that is reliable and repeatable.
4-
ms.date: 07/10/2023
3+
description: WinGet Configuration uses the winget configure command, PowerShell, and a YAML-formatted configuration file listing all of the software versions, packages, tools, and settings required to achieve the set up the desired state of the development environment on your Windows machine. Minimizing manual project setup and onboarding to a single command that is reliable and repeatable.
4+
ms.date: 09/28/2023
55
ms.topic: overview
66
---
77

@@ -13,9 +13,6 @@ Using a WinGet Configuration file, you can consolidate manual machine setup and
1313
- [PowerShell Desired State Configuration (DSC)](/powershell/dsc/overview) to automate the configuration of your Windows operating system.
1414
- The Windows Package Manager [`winget configure` command](../winget/configure.md) to initiate the configuration process.
1515

16-
> [!IMPORTANT]
17-
> WinGet Configuration is currently in preview. To use a WinGet Configuration file with the [`winget configure` command](../winget/configure.md), you must first [enable the experimental configuration feature](#enable-the-winget-configuration-experimental-configuration-preview-feature).
18-
1916
## Benefits for machine setup and project onboarding
2017

2118
The benefits of using a WinGet Configuration file include:
@@ -33,27 +30,7 @@ To set up your machine using a WinGet Configuration file, you can:
3330

3431
1. [Install Dev Home](../../dev-home/index.md), go to **Machine configuration**, select **Configuration file**, and choose the WinGet configuration file that you would like to use. (To create a configuration file, see [How to author a WinGet Configuration file](create.md)).
3532

36-
2. Use [winget configure](../winget/configure.md) in the command line. To use the `winget configure` command, you must be running the preview version of Windows Package Manager and must first [enable the Experimental feature](#enable-the-winget-configuration-experimental-configuration-preview-feature).
37-
38-
## Enable the WinGet Configuration experimental configuration preview feature
39-
40-
In order to use a WinGet Configuration file with the [`winget configure` command](../winget/configure.md):
41-
42-
1. Confirm you're running the [Preview version of WinGet](../winget/index.md#install-winget-preview-version-developers-only).
43-
44-
2. Enter the command: `winget features` to display a list of available experimental features.
45-
46-
3. Enter the command: `winget settings` to open the WinGet Settings file in your default text editor. The WinGet Settings file uses a JSON format.
47-
48-
4. In your WinGet Settings JSON file, enter:
49-
50-
```json
51-
"experimentalFeatures": {
52-
"configuration": true
53-
}
54-
```
55-
56-
Features may be managed by your workplace group policy, potentially blocking your ability to use experimental features. You can use the `winget --info` command to view any policies in effect on your system.
33+
2. Use [winget configure](../winget/configure.md) in the command line. To use the `winget configure` command, you must be running WinGet version [v1.6.2631 or later](https://github.com/microsoft/winget-cli/releases).
5734

5835
## WinGet Configuration FAQs
5936

@@ -114,7 +91,11 @@ The [PowerShell Gallery](https://www.powershellgallery.com/packages) hosts hundr
11491

11592
### Can I set up a policy to block the use of WinGet Configuration files in my organization?
11693

117-
[Group Policy Objects](/microsoft-365/compliance/device-onboarding-gp) are available for disabling all experimental features. New Group Policy Objects will be created for more fine-grained control before WinGet configuration is shipped as a stable product.
94+
Yes. [Group Policy Objects](/microsoft-365/compliance/device-onboarding-gp) **EnableWindowsPackageManagerConfiguration** and **EnableWindowsPackageManagerConfigurationExplanation** can be utilized for disabling WinGet Configuration feature in your organization.
95+
96+
### Where can I learn more about using WinGet Configurations with Dev Home and Dev Drives?
97+
98+
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/).
11899

119100
## Troubleshooting WinGet Configurations
120101

hub/package-manager/winget/configure.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,13 @@ ms.localizationpriority: medium
1010

1111
The **configure** command of the [winget](./index.md) tool uses a [WinGet Configuration file](../configuration/index.md) to begin setting up your Windows machine to a desired development environment state.
1212

13-
> [!IMPORTANT]
14-
> WinGet Configuration is currently in preview. To use a WinGet Configuration file with the [`winget configure` command](../winget/configure.md), you must first [enable the experimental configuration feature](../configuration/index.md#enable-the-winget-configuration-experimental-configuration-preview-feature).
15-
1613
> [!WARNING]
1714
> Do not run a WinGet Configuration file without first reviewing the contents of the file and verifying the credibility of the related resources. See [How to check the trustworthiness of a WinGet Configuration file](../configuration/check.md).
1815
1916
## Prerequisites
2017

2118
- Windows 10 RS5 or later, and Windows 11.
22-
- Winget version v1.5.1572 or later.
19+
- WinGet version [v1.6.2631 or later](https://github.com/microsoft/winget-cli/releases).
2320

2421
## Aliases
2522

0 commit comments

Comments
 (0)