repository.md (5857B)
1 --- 2 title: Submit your manifest to the repository 3 description: After you create a package manifest that describes your application, you're ready to submit your manifest to the Windows Package Manager repository. 4 ms.date: 04/29/2020 5 ms.topic: article 6 ms.localizationpriority: medium 7 --- 8 9 # Submit your manifest to the repository 10 11 After you create a [package manifest](manifest.md) that describes your application, you're ready to submit your manifest to the Windows Package Manager repository. This a public-facing repository that contains a collection of manifests that the **winget** tool can access. To submit your manifest, you'll upload it to the open source [https://github.com/microsoft/winget-pkgs](https://github.com/microsoft/winget-pkgs) repository on GitHub. 12 13 After you submit a **pull request** to add a new manifest to the GitHub repository, an automated process will validate your manifest file and check to make sure the package complies with the [Windows Package Manager polices](windows-package-manager-policies.md) and is not known to be malicious. If this validation is successful, your package will be added to the public-facing Windows Package Manager repository so it can be discovered by the **winget** client tool. Note the distinction between the manifests in the open source GitHub repository and the public-facing Windows Package Manager repository. 14 15 > **Important**: Microsoft reserves the right to refuse a submission for any reason. 16 17 ## Third-party repositories 18 19 There are currently no known third party repositories. Microsoft is working with multiple partners to develop protocols or an API to enable third party repositories. 20 21 ## Manifest validation 22 23 When you submit a manifest to the [https://github.com/microsoft/winget-pkgs](https://github.com/microsoft/winget-pkgs) repository on GitHub, your manifest will be automatically validated and evaluated for the safety of the Windows ecosystem. Manifests will be reviewed manually by [Community Moderators](https://github.com/microsoft/winget-pkgs/issues/15674). 24 25 For information on the validation process, see [Windows Package Manager validation](winget-validation.md) 26 27 ## How to submit your manifest 28 29 To submit a manifest to the repository, follow these steps. 30 31 ### Step 1: Validate your manifest 32 33 The **winget** tool provides the [validate](../winget/validate.md) command to confirm that you have created your manifest correctly. To validate your manifest, use this command. 34 35 ```CMD 36 winget validate <path-to-the-manifests> 37 ``` 38 39 If your validation fails, use the errors to locate the line number and make a correction. After your manifest is validated, you can submit it to the repository. 40 41 ### Step 2: Clone the repository 42 43 Next, create a fork of the repository and clone it. 44 45 1. Go to [https://github.com/microsoft/winget-pkgs](https://github.com/microsoft/winget-pkgs) in your browser and click **Fork**. 46  47 48 2. From a command line environment such as the Windows Command Prompt or PowerShell, use the following command to clone your fork. 49 ```CMD 50 git clone <your-fork-name> 51 ``` 52 53 3. If you are making multiple submissions, make a branch instead of a fork. We currently allow only one manifest file per PR. 54 ```CMD 55 git checkout -b <branch-name> 56 ``` 57 58 ### Step 3: Add your manifest to the local repository 59 60 You must add your manifest files to the repository in the following folder structure: 61 62 **manifests** / **letter** / **publisher** / **application** / **version** 63 64 * The **manifests** folder is the root folder for all manifests in the repository. 65 * The **letter** folder is the first letter of the publisher name in the lower case. For example, **m** of the publisher **Microsoft**. 66 * The **publisher** folder is the name of the company that publishes the software. For example, **Microsoft**. 67 * The **application** folder is the name of the application or tool. For example, **VSCode**. 68 * The **version** folder is the version of the application or tool. For example, **1.0.0**. 69 70 The `PackageIdentifier` and the `PackageVersion` values in the manifest must match the publisher, application names and version in the manifest folder path. For more information, see [Create your package manifest](manifest.md#tips-and-best-practices). 71 72 ### Step 4: Submit your manifest to the remote repository 73 74 You're now ready to push your new manifest to the remote repository. 75 76 1. Use the `commit` command to add files and commit the change and provide information on the submission. 77 ```CMD 78 git commit -m "Submitting ContosoApp version 1.0.0" --all 79 ``` 80 81 3. Use the `push` command to push the changes to the remote repository. 82 ```CMD 83 git push 84 ``` 85 86 ### Step 5: Create a pull request 87 88 After you push your changes, return to [https://github.com/microsoft/winget-pkgs](https://github.com/microsoft/winget-pkgs) and create a **pull request** to merge your fork or branch to the main branch. 89 90  91 92 ## Submission process 93 94 When you create a **pull request**, this will start an automated process that validates the manifests and verifies your **pull request**. During this process we will run tests against the installer and installed binaries to validate the submission. 95 96 We add labels to your **pull request** so you can track its progress. For more information on labels and the process see [Windows Package Manager validation](winget-validation.md). 97 98 Once complete, your submission will be manually reviewed by a moderator, and after it is approved, your application will be added to the Windows Package Manager catalog. 99 100 If there is ever an error during the process, you will be notified and our labels and bot will assist you in fixing your submission. For the list of common errors, see [Windows Package Manager validation](winget-validation.md).