Skip to content

Commit

Permalink
Add Documentation for manifest 1.4 (microsoft#87347)
Browse files Browse the repository at this point in the history 
* Add Documentation for manifest 1.4

* Update docs with respect to .zip

* Clarify language
  • Loading branch information
@Trenly
Trenly authored Jan 24, 2023
1 parent c997aec commit eee108f
Show file tree
Hide file tree
Showing 13 changed files with 2,550 additions and 288 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/package_request.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ body:
value: |
### Important - Please read
> At this time installers must either be MSIX, MSI or .exe application installers.
> Compressed .zip files, and fonts are not currently supported.
> Terminal scripts and fonts are not currently supported.
- type: checkboxes
attributes:
label: Package Requested
options:
- label: I would like someone else to build the manifest.
- label: I would like help so I can submit the manifest.
- label: I have performed a search and couldn't find this package.
- label: I have checked that the installer for this package is not contained in a .zip file
- label: I have checked that the installer for this package is not a script file
- label: I think there is a new version available and I have provided the URL.
- type: textarea
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
- [ ] Have you checked that there aren't other open [pull requests](https://github.com/microsoft/winget-pkgs/pulls) for the same manifest update/change?
- [ ] Have you [validated](https://github.com/microsoft/winget-pkgs/blob/master/AUTHORING_MANIFESTS.md#validation) your manifest locally with `winget validate --manifest <path>`?
- [ ] Have you tested your manifest locally with `winget install --manifest <path>`?
- [ ] Does your manifest conform to the [1.2 schema](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.2.0)?
- [ ] Does your manifest conform to the [1.4 schema](https://github.com/microsoft/winget-pkgs/tree/master/doc/manifest/schema/1.4.0)?

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

Expand Down
278 changes: 2 additions & 276 deletions .github/fabricbot.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@
{
"name": "addReply",
"parameters": {
"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"
"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"
}
},
{
Expand Down Expand Up @@ -2606,240 +2606,6 @@
]
}
},
{
"taskType": "trigger",
"capabilityId": "IssueResponder",
"subCapability": "PullRequestCommentResponder",
"version": "1.0",
"config": {
"conditions": {
"operator": "and",
"operands": [
{
"name": "commentContains",
"parameters": {
"bodyPattern": "/zip",
"isRegex": true,
"commentPattern": "@[mM][sS][fF][tT][bB][oO][tT]\\s+\\.?[zZ]ip"
}
},
{
"operator": "or",
"operands": [
{
"name": "activitySenderHasPermissions",
"parameters": {
"permissions": "admin"
}
},
{
"name": "activitySenderHasPermissions",
"parameters": {
"permissions": "write"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "ImJoakim"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "ItzLevvie"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "jedieaston"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "KaranKad"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "OfficialEsco"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "quhxl"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "Trenly"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "mdanish-kh"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "russellbanks"
}
}
]
}
]
},
"eventType": "pull_request",
"eventNames": [
"issue_comment"
],
"taskName": "Helper to add Interactive-Only-Installer to PR",
"actions": [
{
"name": "addLabel",
"parameters": {
"label": "Needs-Author-Feedback"
}
},
{
"name": "removeLabel",
"parameters": {
"label": "Needs-Attention"
}
},
{
"name": "addLabel",
"parameters": {
"label": ".zip"
}
},
{
"name": "addLabel",
"parameters": {
"label": "Blocking-Issue"
}
}
]
}
},
{
"taskType": "trigger",
"capabilityId": "IssueResponder",
"subCapability": "IssueCommentResponder",
"version": "1.0",
"config": {
"conditions": {
"operator": "and",
"operands": [
{
"name": "commentContains",
"parameters": {
"bodyPattern": "/zip",
"isRegex": true,
"commentPattern": "@[mM][sS][fF][tT][bB][oO][tT]\\s+\\.?[zZ]ip"
}
},
{
"operator": "or",
"operands": [
{
"name": "activitySenderHasPermissions",
"parameters": {
"permissions": "admin"
}
},
{
"name": "activitySenderHasPermissions",
"parameters": {
"permissions": "write"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "ImJoakim"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "ItzLevvie"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "jedieaston"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "KaranKad"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "OfficialEsco"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "quhxl"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "Trenly"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "mdanish-kh"
}
},
{
"name": "isActivitySender",
"parameters": {
"user": "russellbanks"
}
}
]
}
]
},
"eventType": "issue",
"eventNames": [
"issue_comment"
],
"taskName": "Helper to add .zip to Issue",
"actions": [
{
"name": "addLabel",
"parameters": {
"label": ".zip"
}
},
{
"name": "addLabel",
"parameters": {
"label": "Blocking-Issue"
}
}
]
}
},
{
"taskType": "trigger",
"capabilityId": "IssueResponder",
Expand Down Expand Up @@ -6182,46 +5948,6 @@
]
}
},
{
"taskType": "trigger",
"capabilityId": "IssueResponder",
"subCapability": "PullRequestResponder",
"version": "1.0",
"config": {
"conditions": {
"operator": "and",
"operands": [
{
"name": "labelAdded",
"parameters": {
"label": ".zip"
}
}
]
},
"eventType": "pull_request",
"eventNames": [
"pull_request",
"issues",
"project_card"
],
"taskName": "Blocked by .zip",
"actions": [
{
"name": "addReply",
"parameters": {
"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"
}
},
{
"name": "addLabel",
"parameters": {
"label": "Blocking-Issue"
}
}
]
}
},
{
"taskType": "trigger",
"capabilityId": "IssueResponder",
Expand Down Expand Up @@ -6588,7 +6314,7 @@
{
"name": "addReply",
"parameters": {
"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"
"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"
}
},
{
Expand Down
8 changes: 4 additions & 4 deletions AUTHORING_MANIFESTS.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[Manifest Specification]: doc/manifest/schema/1.2.0
[versionSchema]: doc/manifest/schema/1.2.0/version.md
[defaultLocaleSchema]: doc/manifest/schema/1.2.0/defaultLocale.md
[installerSchema]: doc/manifest/schema/1.2.0/installer.md
[Manifest Specification]: doc/manifest/schema/1.4.0
[versionSchema]: doc/manifest/schema/1.4.0/version.md
[defaultLocaleSchema]: doc/manifest/schema/1.4.0/defaultLocale.md
[installerSchema]: doc/manifest/schema/1.4.0/installer.md

# Authoring Manifests

Expand Down
3 changes: 1 addition & 2 deletions Moderation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,4 @@ Moderators are often the first to see and triage new issues, and so they have th
* `Blocking-Issue`
* `Interactive-Only-Installer`
* `Dependencies`
* `.zip`
> Note: Adding `Interactive-Only-Installer`, `Dependencies`, or `.zip` will automatically add `Blocking-Issue`
> Note: Adding `Interactive-Only-Installer` or `Dependencies`, will automatically add `Blocking-Issue`
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Github Status](https://img.shields.io/endpoint?url=https://api.bittu.eu.org/github-status-badge-endpoint)](https://www.githubstatus.com)

This repository contains the manifest files for the **Windows Package Manager** default source. You are highly encouraged to submit manifests for your favorite application.
> Note: At this time installers must either be MSIX, MSI or .exe application installers. Compressed .zip files and fonts are not currently supported.
> Note: At this time installers must be MSIX, MSI, APPX, or .exe application installers. Script-based installers and fonts are not currently supported.
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).

Expand Down
4 changes: 2 additions & 2 deletions Tools/SandboxTest.ps1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,14 +164,14 @@ $uiLibsUwp.pathInSandbox = Join-Path -Path $desktopInSandbox -ChildPath (Join-Pa
Write-Host

# Create Bootstrap settings
# dependencies and zipInstall are enabled for forward compatibility with PR's
# Experimental features can be enabled for forward compatibility with PR's
$bootstrapSettingsContent = @{}
$bootstrapSettingsContent['$schema'] = 'https://aka.ms/winget-settings.schema.json'
$bootstrapSettingsContent['logging'] = @{level = 'verbose' }
if ($EnableExperimentalFeatures) {
$bootstrapSettingsContent['experimentalFeatures'] = @{
dependencies = $true
zipInstall = $true
openLogsArgument = $true
}
}

Expand Down
Loading

0 comments on commit eee108f

Please sign in to comment.