winget-pkgs/doc

Documentation Overview

Authoring a Manifest

A few different tools are available to help you author a manifest.

• Windows Package Manager Manifest Creator
• YamlCreate.ps1
• Other WinGet Manifest Creators developed by the community:
  • Komac - Community Manifest Creator (maintained by @russellbanks)

[!Note] Only one manifest may be submitted per PR.

Testing a Manifest

Now that you have authored your manifest, you should make sure it works as expected.

[!Note] You will need to run winget settings --enable LocalManifestFiles in an administrative shell before working with local manifests.

Locally

1. Verify the syntax by executing the following command:

winget validate --manifest <path-to-manifest>

2. Test the install by executing the following command:

winget install --manifest <path-to-manifest>

For more details, see "Submit packages to Windows Package Manager" at Microsoft Docs.

In Windows Sandbox

You can use the Sandbox Test PowerShell script for testing a manifest installation in Windows Sandbox. The manifest will be also validated.

Just provide the path to manifest as parameter:

.\Tools\SandboxTest.ps1 <path-to-manifest>

Submitting a Manifest

To submit a package to this repository, you should follow these steps:

1. Follow the Contributing guidelines below.
2. Author a Manifest.
3. Test your manifest.
4. Submit your pull request (PR).
5. Respond to any feedback in your PR.

[!Note] Please check the package's manifest you intend to submit does not already exist in the repository, and there are no open PRs for it in order to avoid duplicates.

Submit your PR

Once you have verified your manifest, it's time to submit a PR. Place your manifest in a folder path that matches the following structure:

manifests\<first lower case letter of publisher>\<publisher>\<package>\<version>\

Validation Process

Your PR will go through a validation process. The core team or the Microsoft bot (BOT) will use labels to assist during the process. In case of a failure, the BOT will suggest the problem with the submission and assign the PR back to you.

Respond to PR feedback

If your PR has been assigned to you, a timer will be triggered. You will have 7 days to resolve the issue, or the BOT will automatically close the PR.

Submissions to the repository are reviewed by Windows Package Manager administrators and/or community moderators. To help identify these individuals, we have provided a Public Service Announcement.