Skip to content

docs(submit): clarify that --prtitle and --token are optional #707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Reginald Alfret V (reginaldalfret) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(submit): clarify that --prtitle and --token are optional #707

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/submit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ To use the **submit** command, you simply need to provide your [GitHub token](ht

Submit local manifest file to Windows Package Manager repo:

`wingetcreate.exe submit --prtitle <PullRequestTitle> --token <GitHubPersonalAccessToken> <PathToManifest>`
`wingetcreate.exe submit [--prtitle <PullRequestTitle>] [--token <GitHubPersonalAccessToken>] <PathToManifest>`

## Arguments

The following arguments are available:

| Argument | Description |
|--------------|-------------|
| **-p, --prtitle** | The title of the pull request submitted to GitHub.
| **-r, --replace** | Boolean value for replacing an existing manifest from the Windows Package Manager repo. Optionally provide a version or else the latest version will be replaced. Default is false.
| **-p, --prtitle** | (Optional) The title of the pull request submitted to GitHub. If omitted, a title is automatically generated. |
| **-r, --replace** | Boolean value for replacing an existing manifest from the Windows Package Manager repo. Optionally provide a version or else the latest version will be replaced. Default is false. |
| **-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. <br/>⚠️ _Using this argument may result in the token being logged. Consider an alternative approach https://aka.ms/winget-create-token._ |
| **-n, --no-open** | Boolean value that controls whether the pull request should not be open in the browser on submission. Default is false, meaning the PR will be opened in the browser. |
| **-?, --help** | Gets additional help on this command. |
Expand Down
Loading