Skip to content

Commit

Permalink
Include PAT creation instructions in commands docs (#375)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdanish-kh committed May 16, 2023
1 parent e495915 commit b1b08f3
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions doc/new.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 3 additions & 1 deletion doc/submit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions doc/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [\<options>]`
Expand Down
1 change: 1 addition & 0 deletions doc/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit b1b08f3

Please sign in to comment.