Skip to content

Commit e4ceb24

Browse files
authored
Merge pull request #4869 from rakleed/patch-2
Add links with detailed descriptions of manifest fields
2 parents 49fd7eb + 2025602 commit e4ceb24

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

hub/package-manager/package/manifest.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Installers:
7878
InstallerUrl: # Path to download installation file.
7979
InstallerSha256: # SHA256 calculated from installer.
8080
ManifestType: # The manifest file type
81-
ManifestVersion: 1.0.0
81+
ManifestVersion: 1.5.0
8282
```
8383
8484
#### [Example](#tab/minexample/)
@@ -100,7 +100,7 @@ Installers:
100100
InstallerSha256: 092aa89b1881e058d31b1a8d88f31bb298b5810afbba25c5cb341cfa4904d843
101101
SignatureSha256: e53f48473621390c8243ada6345826af7c713cf1f4bbbf0d030599d1e4c175ee
102102
ManifestType: singleton
103-
ManifestVersion: 1.0.0
103+
ManifestVersion: 1.5.0
104104
```
105105
106106
* * *
@@ -110,10 +110,10 @@ ManifestVersion: 1.0.0
110110
To provide the best user experience, manifests should contain as much meta-data as possible. In order to separate concerns for validating installers
111111
and providing localized metadata, manifests should be split into multiple files. The minimum number of YAML files for this kind of manifest is three. Additional locales should also be provided.
112112
113-
* A [version](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.version.1.5.0.json) file.
114-
* The [default locale](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.defaultLocale.1.5.0.json) file.
115-
* An [installer](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.installer.1.5.0.json) file.
116-
* Additional [locale](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.locale.1.5.0.json) files.
113+
* A [version](https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.5.0/version.md) ([JSON Schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.version.1.5.0.json)) file.
114+
* The [default locale](https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.5.0/defaultLocale.md) ([JSON Schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.defaultLocale.1.5.0.json)) file.
115+
* An [installer](https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.5.0/installer.md) ([JSON Schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.installer.1.5.0.json)) file.
116+
* Additional [locale](https://github.com/microsoft/winget-pkgs/blob/master/doc/manifest/schema/1.5.0/locale.md) ([JSON Schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/manifests/v1.5.0/manifest.locale.1.5.0.json)) files.
117117
118118
The example below shows many optional metadata fields and multiple locales. Note the default locale has more requirements than additional locales. In the [show command](../winget/show.md), any required fields that aren't provided for additional locales will display fields from the default locale.
119119
@@ -126,7 +126,7 @@ PackageIdentifier: "Microsoft.WindowsTerminal"
126126
PackageVersion: "1.6.10571.0"
127127
DefaultLocale: "en-US"
128128
ManifestType: "version"
129-
ManifestVersion: "1.0.0"
129+
ManifestVersion: "1.5.0"
130130
```
131131
132132
#### [Default locale file example](#tab/default-locale-example/)
@@ -159,7 +159,7 @@ Tags:
159159
- "ps"
160160
- "terminal"
161161
ManifestType: "defaultLocale"
162-
ManifestVersion: "1.0.0"
162+
ManifestVersion: "1.5.0"
163163
```
164164
165165
#### [Additional locale file example](#tab/additional-locale-example/)
@@ -173,7 +173,7 @@ PackageLocale: "fr-FR"
173173
Publisher: "Microsoft"
174174
ShortDescription: "Le nouveau terminal Windows, une expérience de ligne de commande à onglets pour Windows."
175175
ManifestType: "locale"
176-
ManifestVersion: "1.0.0"
176+
ManifestVersion: "1.5.0"
177177
```
178178
179179
#### [Installer file example](#tab/installer-example/)
@@ -204,7 +204,7 @@ Installers:
204204
InstallerSha256: 092aa89b1881e058d31b1a8d88f31bb298b5810afbba25c5cb341cfa4904d843
205205
SignatureSha256: e53f48473621390c8243ada6345826af7c713cf1f4bbbf0d030599d1e4c175ee
206206
ManifestType: "installer"
207-
ManifestVersion: "1.0.0"
207+
ManifestVersion: "1.5.0"
208208
```
209209
210210
* * *

0 commit comments

Comments
 (0)