Skip to content

Commit eee108f

Browse files
TrenlyTrenly
authored
Add Documentation for manifest 1.4 (#87347)
* Add Documentation for manifest 1.4 * Update docs with respect to .zip * Clarify language
1 parent c997aec commit eee108f

13 files changed

+2550
-288
lines changed

‎.github/ISSUE_TEMPLATE/package_request.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ body:
88
value: |
99
### Important - Please read
1010
> At this time installers must either be MSIX, MSI or .exe application installers.
11-
> Compressed .zip files, and fonts are not currently supported.
11+
> Terminal scripts and fonts are not currently supported.
1212
- type: checkboxes
1313
attributes:
1414
label: Package Requested
1515
options:
1616
- label: I would like someone else to build the manifest.
1717
- label: I would like help so I can submit the manifest.
1818
- label: I have performed a search and couldn't find this package.
19-
- label: I have checked that the installer for this package is not contained in a .zip file
19+
- label: I have checked that the installer for this package is not a script file
2020
- label: I think there is a new version available and I have provided the URL.
2121
- type: textarea
2222
attributes:

‎.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
- [ ] Have you checked that there aren't other open [pull requests](https://github.com/microsoft/winget-pkgs/pulls) for the same manifest update/change?
33
- [ ] Have you [validated](https://github.com/microsoft/winget-pkgs/blob/master/AUTHORING_MANIFESTS.md#validation) your manifest locally with `winget validate --manifest <path>`?
44
- [ ] Have you tested your manifest locally with `winget install --manifest <path>`?
5-
- [ ] Does your manifest conform to the [1.2 schema](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0)?
5+
- [ ] Does your manifest conform to the [1.4 schema](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.4.0)?
66

77
Note: `<path>` is the name of the directory containing the manifest you're submitting.
88

‎.github/fabricbot.json

+2-276
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
{
9696
"name": "addReply",
9797
"parameters": {
98-
"comment": "Hello @${issueAuthor},\n\nThe package manager bot determined that the metadata was not compliant.\n\nPlease verify the manifest file is compliant with the package manager [1.2 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0).\nMake sure the ID is of the form publisher.appname and that the folder structure is manifests\\partition\\publisher\\appname\\version.\nNote: The path and \"PackageIdentifier\" are case sensitive.\nBe sure to use a tool like [VSCode](https://code.visualstudio.com/) to make sure the manifest YAML syntax is correct.\n\nYou could also try our [Windows Package Manager Manifest Creator](https://github.com/microsoft/winget-create) or the [YamlCreate script](https://github.com/microsoft/winget-pkgs/blob/master/doc/tools/YamlCreate.md).\n\nFor details on the specific error, see the details link below in the build pipeline.\n\nTemplate: msftbot/validationError/manifest/metadata"
98+
"comment": "Hello @${issueAuthor},\n\nThe package manager bot determined that the metadata was not compliant.\n\nPlease verify the manifest file is compliant with the package manager [1.4 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.4.0).\nMake sure the ID is of the form publisher.appname and that the folder structure is manifests\\partition\\publisher\\appname\\version.\nNote: The path and \"PackageIdentifier\" are case sensitive.\nBe sure to use a tool like [VSCode](https://code.visualstudio.com/) to make sure the manifest YAML syntax is correct.\n\nYou could also try our [Windows Package Manager Manifest Creator](https://github.com/microsoft/winget-create) or the [YamlCreate script](https://github.com/microsoft/winget-pkgs/blob/master/doc/tools/YamlCreate.md).\n\nFor details on the specific error, see the details link below in the build pipeline.\n\nTemplate: msftbot/validationError/manifest/metadata"
9999
}
100100
},
101101
{
@@ -2606,240 +2606,6 @@
26062606
]
26072607
}
26082608
},
2609-
{
2610-
"taskType": "trigger",
2611-
"capabilityId": "IssueResponder",
2612-
"subCapability": "PullRequestCommentResponder",
2613-
"version": "1.0",
2614-
"config": {
2615-
"conditions": {
2616-
"operator": "and",
2617-
"operands": [
2618-
{
2619-
"name": "commentContains",
2620-
"parameters": {
2621-
"bodyPattern": "/zip",
2622-
"isRegex": true,
2623-
"commentPattern": "@[mM][sS][fF][tT][bB][oO][tT]\\s+\\.?[zZ]ip"
2624-
}
2625-
},
2626-
{
2627-
"operator": "or",
2628-
"operands": [
2629-
{
2630-
"name": "activitySenderHasPermissions",
2631-
"parameters": {
2632-
"permissions": "admin"
2633-
}
2634-
},
2635-
{
2636-
"name": "activitySenderHasPermissions",
2637-
"parameters": {
2638-
"permissions": "write"
2639-
}
2640-
},
2641-
{
2642-
"name": "isActivitySender",
2643-
"parameters": {
2644-
"user": "ImJoakim"
2645-
}
2646-
},
2647-
{
2648-
"name": "isActivitySender",
2649-
"parameters": {
2650-
"user": "ItzLevvie"
2651-
}
2652-
},
2653-
{
2654-
"name": "isActivitySender",
2655-
"parameters": {
2656-
"user": "jedieaston"
2657-
}
2658-
},
2659-
{
2660-
"name": "isActivitySender",
2661-
"parameters": {
2662-
"user": "KaranKad"
2663-
}
2664-
},
2665-
{
2666-
"name": "isActivitySender",
2667-
"parameters": {
2668-
"user": "OfficialEsco"
2669-
}
2670-
},
2671-
{
2672-
"name": "isActivitySender",
2673-
"parameters": {
2674-
"user": "quhxl"
2675-
}
2676-
},
2677-
{
2678-
"name": "isActivitySender",
2679-
"parameters": {
2680-
"user": "Trenly"
2681-
}
2682-
},
2683-
{
2684-
"name": "isActivitySender",
2685-
"parameters": {
2686-
"user": "mdanish-kh"
2687-
}
2688-
},
2689-
{
2690-
"name": "isActivitySender",
2691-
"parameters": {
2692-
"user": "russellbanks"
2693-
}
2694-
}
2695-
]
2696-
}
2697-
]
2698-
},
2699-
"eventType": "pull_request",
2700-
"eventNames": [
2701-
"issue_comment"
2702-
],
2703-
"taskName": "Helper to add Interactive-Only-Installer to PR",
2704-
"actions": [
2705-
{
2706-
"name": "addLabel",
2707-
"parameters": {
2708-
"label": "Needs-Author-Feedback"
2709-
}
2710-
},
2711-
{
2712-
"name": "removeLabel",
2713-
"parameters": {
2714-
"label": "Needs-Attention"
2715-
}
2716-
},
2717-
{
2718-
"name": "addLabel",
2719-
"parameters": {
2720-
"label": ".zip"
2721-
}
2722-
},
2723-
{
2724-
"name": "addLabel",
2725-
"parameters": {
2726-
"label": "Blocking-Issue"
2727-
}
2728-
}
2729-
]
2730-
}
2731-
},
2732-
{
2733-
"taskType": "trigger",
2734-
"capabilityId": "IssueResponder",
2735-
"subCapability": "IssueCommentResponder",
2736-
"version": "1.0",
2737-
"config": {
2738-
"conditions": {
2739-
"operator": "and",
2740-
"operands": [
2741-
{
2742-
"name": "commentContains",
2743-
"parameters": {
2744-
"bodyPattern": "/zip",
2745-
"isRegex": true,
2746-
"commentPattern": "@[mM][sS][fF][tT][bB][oO][tT]\\s+\\.?[zZ]ip"
2747-
}
2748-
},
2749-
{
2750-
"operator": "or",
2751-
"operands": [
2752-
{
2753-
"name": "activitySenderHasPermissions",
2754-
"parameters": {
2755-
"permissions": "admin"
2756-
}
2757-
},
2758-
{
2759-
"name": "activitySenderHasPermissions",
2760-
"parameters": {
2761-
"permissions": "write"
2762-
}
2763-
},
2764-
{
2765-
"name": "isActivitySender",
2766-
"parameters": {
2767-
"user": "ImJoakim"
2768-
}
2769-
},
2770-
{
2771-
"name": "isActivitySender",
2772-
"parameters": {
2773-
"user": "ItzLevvie"
2774-
}
2775-
},
2776-
{
2777-
"name": "isActivitySender",
2778-
"parameters": {
2779-
"user": "jedieaston"
2780-
}
2781-
},
2782-
{
2783-
"name": "isActivitySender",
2784-
"parameters": {
2785-
"user": "KaranKad"
2786-
}
2787-
},
2788-
{
2789-
"name": "isActivitySender",
2790-
"parameters": {
2791-
"user": "OfficialEsco"
2792-
}
2793-
},
2794-
{
2795-
"name": "isActivitySender",
2796-
"parameters": {
2797-
"user": "quhxl"
2798-
}
2799-
},
2800-
{
2801-
"name": "isActivitySender",
2802-
"parameters": {
2803-
"user": "Trenly"
2804-
}
2805-
},
2806-
{
2807-
"name": "isActivitySender",
2808-
"parameters": {
2809-
"user": "mdanish-kh"
2810-
}
2811-
},
2812-
{
2813-
"name": "isActivitySender",
2814-
"parameters": {
2815-
"user": "russellbanks"
2816-
}
2817-
}
2818-
]
2819-
}
2820-
]
2821-
},
2822-
"eventType": "issue",
2823-
"eventNames": [
2824-
"issue_comment"
2825-
],
2826-
"taskName": "Helper to add .zip to Issue",
2827-
"actions": [
2828-
{
2829-
"name": "addLabel",
2830-
"parameters": {
2831-
"label": ".zip"
2832-
}
2833-
},
2834-
{
2835-
"name": "addLabel",
2836-
"parameters": {
2837-
"label": "Blocking-Issue"
2838-
}
2839-
}
2840-
]
2841-
}
2842-
},
28432609
{
28442610
"taskType": "trigger",
28452611
"capabilityId": "IssueResponder",
@@ -6182,46 +5948,6 @@
61825948
]
61835949
}
61845950
},
6185-
{
6186-
"taskType": "trigger",
6187-
"capabilityId": "IssueResponder",
6188-
"subCapability": "PullRequestResponder",
6189-
"version": "1.0",
6190-
"config": {
6191-
"conditions": {
6192-
"operator": "and",
6193-
"operands": [
6194-
{
6195-
"name": "labelAdded",
6196-
"parameters": {
6197-
"label": ".zip"
6198-
}
6199-
}
6200-
]
6201-
},
6202-
"eventType": "pull_request",
6203-
"eventNames": [
6204-
"pull_request",
6205-
"issues",
6206-
"project_card"
6207-
],
6208-
"taskName": "Blocked by .zip",
6209-
"actions": [
6210-
{
6211-
"name": "addReply",
6212-
"parameters": {
6213-
"comment": "Hello @${issueAuthor},\n\nThis package appears to reference a compressed .zip archive rather than an installer.\n\nThis PR is blocked until support for .zip is implemented in:\n* microsoft/winget-cli/issues/140\n\nTemplate: msftbot/blockingIssue/zipInstaller"
6214-
}
6215-
},
6216-
{
6217-
"name": "addLabel",
6218-
"parameters": {
6219-
"label": "Blocking-Issue"
6220-
}
6221-
}
6222-
]
6223-
}
6224-
},
62255951
{
62265952
"taskType": "trigger",
62275953
"capabilityId": "IssueResponder",
@@ -6588,7 +6314,7 @@
65886314
{
65896315
"name": "addReply",
65906316
"parameters": {
6591-
"comment": "Hello @${issueAuthor},\n\nThe package manager bot determined that the ManifestVersion key does not match any version currently approved for release.Please verify the manifest file is compliant with the package manager [1.0 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.0.0), [1.1 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.1.0), or [1.2 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0).\n\nFor details on the specific error, see the details link below in the build pipeline.\n\nTemplate: msftbot/validationError/manifest/version"
6317+
"comment": "Hello @${issueAuthor},\n\nThe package manager bot determined that the ManifestVersion key does not match any version currently approved for release.Please verify the manifest file is compliant with the package manager [1.0 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.0.0), [1.1 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.1.0), [1.2 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0), or [1.4 manifest specification](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.4.0).\n\nFor details on the specific error, see the details link below in the build pipeline.\n\nTemplate: msftbot/validationError/manifest/version"
65926318
}
65936319
},
65946320
{

‎AUTHORING_MANIFESTS.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
[Manifest Specification]: doc/manifest/schema/1.2.0
2-
[versionSchema]: doc/manifest/schema/1.2.0/version.md
3-
[defaultLocaleSchema]: doc/manifest/schema/1.2.0/defaultLocale.md
4-
[installerSchema]: doc/manifest/schema/1.2.0/installer.md
1+
[Manifest Specification]: doc/manifest/schema/1.4.0
2+
[versionSchema]: doc/manifest/schema/1.4.0/version.md
3+
[defaultLocaleSchema]: doc/manifest/schema/1.4.0/defaultLocale.md
4+
[installerSchema]: doc/manifest/schema/1.4.0/installer.md
55

66
# Authoring Manifests
77

‎Moderation.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -73,5 +73,4 @@ Moderators are often the first to see and triage new issues, and so they have th
7373
* `Blocking-Issue`
7474
* `Interactive-Only-Installer`
7575
* `Dependencies`
76-
* `.zip`
77-
> Note: Adding `Interactive-Only-Installer`, `Dependencies`, or `.zip` will automatically add `Blocking-Issue`
76+
> Note: Adding `Interactive-Only-Installer` or `Dependencies`, will automatically add `Blocking-Issue`

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Github Status](https://img.shields.io/endpoint?url=https://api.bittu.eu.org/github-status-badge-endpoint)](https://www.githubstatus.com)
66

77
This repository contains the manifest files for the **Windows Package Manager** default source. You are highly encouraged to submit manifests for your favorite application.
8-
> Note: At this time installers must either be MSIX, MSI or .exe application installers. Compressed .zip files and fonts are not currently supported.
8+
> Note: At this time installers must be MSIX, MSI, APPX, or .exe application installers. Script-based installers and fonts are not currently supported.
99
1010
The **Windows Package Manager** is an [open source client](https://github.com/microsoft/winget-cli) designed for command-line usage. If you are interested in exploring third-party repositories offering private winget package hosting, see [third-party repositories](THIRD_PARTY.md).
1111

‎Tools/SandboxTest.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,14 @@ $uiLibsUwp.pathInSandbox = Join-Path -Path $desktopInSandbox -ChildPath (Join-Pa
164164
Write-Host
165165

166166
# Create Bootstrap settings
167-
# dependencies and zipInstall are enabled for forward compatibility with PR's
167+
# Experimental features can be enabled for forward compatibility with PR's
168168
$bootstrapSettingsContent = @{}
169169
$bootstrapSettingsContent['$schema'] = 'https://aka.ms/winget-settings.schema.json'
170170
$bootstrapSettingsContent['logging'] = @{level = 'verbose' }
171171
if ($EnableExperimentalFeatures) {
172172
$bootstrapSettingsContent['experimentalFeatures'] = @{
173173
dependencies = $true
174-
zipInstall = $true
174+
openLogsArgument = $true
175175
}
176176
}
177177

0 commit comments

Comments
 (0)