From b7de1aaf2d23d1fd8fc2569f99a0ebf2465899fd Mon Sep 17 00:00:00 2001 From: Muhammad Danish Date: Tue, 16 May 2023 23:54:03 +0500 Subject: [PATCH] Include PAT creation instructions in commands docs --- README.md | 2 +- doc/new.md | 4 ++-- doc/submit.md | 4 +++- doc/token.md | 2 ++ doc/update.md | 1 + 5 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 61892bbe..eb72e4e0 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ Windows Server 2022 now supports App Execution Aliases, which means the alias `w The CLI also supports creating or updating manifests with multiple installer URLs. You can either create new manifests with multiple installer nodes using the [New Command](doc/new.md) or update existing manifests with multiple installer URLs using the [Update Command](doc/update.md). -## GitHub Personal Access Token Permissions +## GitHub Personal Access Token (classic) Permissions When [creating your own GitHub Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to be used with WingetCreate, make sure the following permissions are selected. diff --git a/doc/new.md b/doc/new.md index 37b5779a..87e8ea8d 100644 --- a/doc/new.md +++ b/doc/new.md @@ -65,6 +65,6 @@ If you are content with the changes, choose **no** and the manifest will be save The last option **Winget-Create** will offer is for you to submit the manifest to the [Windows Package Manager repository](https://github.com/microsoft/winget-pkgs). If you choose yes, you will automatically submit your Pull Request (PR) to the [Windows Package Manager repository](https://github.com/microsoft/winget-pkgs). -> [!NOTE] -If you have not logged on to GitHub, you will be taken to the GitHub authentication web page before allowing you to submit your manifest. +If you have provided your [GitHub token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) on the command line, you can skip the login process. Instructions on setting up GitHub Token for Winget-Create can be found [here](../README.md#github-personal-access-token-classic-permissions). +> **Note**: If you have not logged on to GitHub, you will be taken to the GitHub authentication web page before allowing you to submit your manifest. diff --git a/doc/submit.md b/doc/submit.md index fcfccd6c..2450fa07 100644 --- a/doc/submit.md +++ b/doc/submit.md @@ -18,7 +18,9 @@ The following arguments are available: | **-p, --prtitle** | The title of the pull request submitted to GitHub. Default is "{PackageId} version {Version}" | **-t, --token** | GitHub personal access token used for direct submission to the Windows Package Manager repo. If no token is provided, tool will prompt for GitHub login credentials. -If you have provided your [GitHub token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) on the command line along with the **--submit** command and the device is registered with Github, **WingetCreate** will submit your PR to [Windows Package Manager repo](https://docs.microsoft.com/windows/package-manager/). +If you have provided your [GitHub token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) on the command line with the **submit** command and the device is registered with GitHub, **Winget-Create** will submit your PR to [Windows Package Manager repo](https://docs.microsoft.com/windows/package-manager/). + +Instructions on setting up GitHub Token for Winget-Create can be found [here](../README.md#github-personal-access-token-classic-permissions). ## Output diff --git a/doc/token.md b/doc/token.md index c0f2d955..7f6e694e 100644 --- a/doc/token.md +++ b/doc/token.md @@ -3,6 +3,8 @@ The **token** command of the [Winget-Create](../README.md) tool is designed to manage cached GitHub personal access tokens used by the tool for interacting with the [Windows Package Manager repo](https://docs.microsoft.com/windows/package-manager/) automatically. To use the **token** command, you can specify whether you want to store a new [GitHub token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) or clear any existing cached tokens. If you choose not to provide a token when storing, the tool will initiate an OAuth flow and prompt for your GitHub login credentials. +Instructions on setting up GitHub Token for Winget-Create can be found [here](../README.md#github-personal-access-token-classic-permissions). + ## Usage `wingetcreate.exe token [\]` diff --git a/doc/update.md b/doc/update.md index 3609c50c..3d3787d7 100644 --- a/doc/update.md +++ b/doc/update.md @@ -58,5 +58,6 @@ The following arguments are available: If you have provided your [GitHub token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) on the command line along with the **--submit** flag, **Winget-Create** will automatically submit your PR to [Windows Package Manager repo](https://docs.microsoft.com/windows/package-manager/). +Instructions on setting up GitHub Token for Winget-Create can be found [here](../README.md#github-personal-access-token-classic-permissions). ## Output If you would like to write the file to disk rather than submit to the repository, you can pass in the **--output** command along with the file name to write to.