commit 2805c27f5fd2ab709befd470aaa05aaa9925d128
parent 0f57913e234696d2ed67e5ac5966f90b3f63147a
Author: Kaleb Luedtke <jluedtk@jci.com>
Date: Fri, 6 Jan 2023 19:00:42 -0600
Update Documentation for manifest 1.4 (#2659)
Diffstat:
4 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/doc/windows-package-manager-release-roadmap.md b/doc/windows-package-manager-release-roadmap.md
@@ -41,7 +41,6 @@ We use [GitHub milestones](https://github.com/microsoft/winget-cli/milestones) t
| Milestone | Description |
| --- | --- |
-| [v1.4-Client](https://github.com/microsoft/winget-cli/milestone/38) | Work Targeted for v1.4 |
| [v1.5-Client](https://github.com/microsoft/winget-cli/milestone/39) | Work Targeted for v1.5 |
| [v.Next-Client](https://github.com/microsoft/winget-cli/milestone/34) | Triage for the next Milestone |
| [Backlog-Client](https://github.com/microsoft/winget-cli/milestone/2) | Work not yet assigned to a milestone or release |
diff --git a/doc/windows/package-manager/package/manifest.md b/doc/windows/package-manager/package/manifest.md
@@ -52,7 +52,7 @@ For a complete list and descriptions of items in a manifest, see the [manifest s
#### [Minimal required schema](#tab/minschema/)
-As specified in the [singleton JSON schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.singleton.1.2.0.json),
+As specified in the [singleton JSON schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.singleton.1.4.0.json),
only a number of fields are required. The minimal supported YAML file would look like the example below. The singleton format is only valid for packages containing
a single installer and a single locale. If more than one installer or locale is provided, the multiple YAML file format and schema must be used.
@@ -73,7 +73,7 @@ Installers:
InstallerUrl: # Path to download installation file.
InstallerSha256: # SHA256 calculated from installer.
ManifestType: # The manifest file type
-ManifestVersion: 1.2.0
+ManifestVersion: 1.4.0
```
#### [Example](#tab/minexample/)
@@ -95,17 +95,17 @@ Installers:
InstallerSha256: 092aa89b1881e058d31b1a8d88f31bb298b5810afbba25c5cb341cfa4904d843
SignatureSha256: e53f48473621390c8243ada6345826af7c713cf1f4bbbf0d030599d1e4c175ee
ManifestType: singleton
-ManifestVersion: 1.2.0
+ManifestVersion: 1.4.0
```
#### Multiple File Example
In order to provide the best user experience, manifests should contain as much meta-data as possible. In order to separate concerns for validating installers
and providing localized meta-data manifests will be split into multiple files. The minimum number of YAML files for this kind of manifest is three. Additional
locales should also be provided.
-* A [version](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.version.1.2.0.json) file
-* The [default locale](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.defaultLocale.1.2.0.json) file
-* An [installer](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.installer.1.2.0.json) file
-* Additional [locale](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.locale.1.2.0.json) files
+* A [version](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.version.1.4.0.json) file
+* The [default locale](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.defaultLocale.1.4.0.json) file
+* An [installer](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.installer.1.4.0.json) file
+* Additional [locale](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.locale.1.4.0.json) files
The example below shows many optional meta-data fields and multiple locales. Note the default locale has more requirements than additional locales. In the show
command, any required fields that aren't provided for additional locales will display fields from the default locale.
@@ -117,7 +117,7 @@ PackageIdentifier: Microsoft.WindowsTerminal
PackageVersion: 1.6.10571.0
DefaultLocale: en-US
ManifestType: version
-ManifestVersion: 1.2.0
+ManifestVersion: 1.4.0
```
Path: manifests / m / Microsoft / WindowsTerminal / 1.6.10571.0 / Microsoft.WindowsTerminal.locale.en-US.yaml
@@ -148,7 +148,7 @@ Tags:
- ps
- terminal
ManifestType: defaultLocale
-ManifestVersion: 1.2.0
+ManifestVersion: 1.4.0
```
Path: manifests / m / Microsoft / WindowsTerminal / 1.6.10571.0 / Microsoft.WindowsTerminal.locale.fr-FR.yaml
@@ -160,7 +160,7 @@ PackageLocale: fr-FR
Publisher: Microsoft
ShortDescription: Le nouveau terminal Windows, une expérience de ligne de commande à onglets pour Windows.
ManifestType: locale
-ManifestVersion: 1.2.0
+ManifestVersion: 1.4.0
```
Path: manifests / m / Microsoft / WindowsTerminal / 1.6.10571.0 / Microsoft.WindowsTerminal.installer.yaml
@@ -189,7 +189,7 @@ Installers:
InstallerSha256: 092aa89b1881e058d31b1a8d88f31bb298b5810afbba25c5cb341cfa4904d843
SignatureSha256: e53f48473621390c8243ada6345826af7c713cf1f4bbbf0d030599d1e4c175ee
ManifestType: installer
-ManifestVersion: 1.2.0
+ManifestVersion: 1.4.0
```
* * *
diff --git a/doc/windows/package-manager/package/windows-package-manager-policies.md b/doc/windows/package-manager/package/windows-package-manager-policies.md
@@ -65,14 +65,14 @@ All aspects of the Product should accurately describe the functions, features an
### 1.1.2
-[Tags](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.defaultLocale.1.2.0.json) may not exceed 16 unique tags and should be relevant to the Product.
+[Tags](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.defaultLocale.1.4.0.json) may not exceed 16 unique tags and should be relevant to the Product.
### 1.1.3
The Product must have distinct and informative metadata and must provide a valuable and quality user experience.
### 1.1.4
-The [InstallerUrl](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.defaultLocale.1.2.0.json) must be the ISVs release location for the Product. Products from download websites will not be allowed.
+The [InstallerUrl](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.defaultLocale.1.4.0.json) must be the ISVs release location for the Product. Products from download websites will not be allowed.
### 1.2 Security
@@ -118,7 +118,7 @@ The following requirements apply to Products that access Personal Information. P
### 1.5.1
-If the Product accesses, collects or transmits Personal Information, or if otherwise required by law, it should maintain a privacy policy. The submission, should include the [PrivacyUrl](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.2.0/manifest.defaultLocale.1.2.0.json) which links to the privacy policy of the Product.
+If the Product accesses, collects or transmits Personal Information, or if otherwise required by law, it should maintain a privacy policy. The submission, should include the [PrivacyUrl](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.4.0/manifest.defaultLocale.1.4.0.json) which links to the privacy policy of the Product.
### 1.5.2
diff --git a/doc/windows/package-manager/winget/index.md b/doc/windows/package-manager/winget/index.md
@@ -71,6 +71,7 @@ The current version of the **winget** tool supports the following options.
| **-v, --version** | Returns the current version of winget. |
| **--info** | Provides you with all detailed information on winget, including the links to the license, privacy statement, and configured group policies. |
| **-?, --help** | Shows additional help for winget. |
+| **--wait** | Waits for user input upon command completion. |
## Supported installer formats
@@ -84,6 +85,7 @@ The current version of the **winget** tool supports the following types of insta
* MSIX
* BURN
* PORTABLE
+* ZIP
## Scripting winget
