-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
gh-pr-checks: add pages; gh-pr-merge: update page #18506
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# gh pr checks | ||
|
||
> View CI checks for a GitHub pull request. | ||
> More information: <https://cli.github.com/manual/gh_pr_checks>. | ||
|
||
- Show checks for the pull request of the current branch: | ||
|
||
`gh pr checks` | ||
|
||
- Show checks for a specific pull request: | ||
|
||
`gh pr checks {{123}}` | ||
|
||
- Watch checks and update in real time until completion: | ||
|
||
`gh pr checks {{123}} --watch` | ||
|
||
- Show only required checks: | ||
|
||
`gh pr checks {{123}} --required` |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,32 +1,28 @@ | ||||||
# gh pr merge | ||||||
|
||||||
> Merge GitHub pull requests. | ||||||
> Merge a GitHub pull request. | ||||||
> More information: <https://cli.github.com/manual/gh_pr_merge>. | ||||||
- Merge the pull request associated with the current branch interactively: | ||||||
|
||||||
`gh pr merge` | ||||||
|
||||||
- Merge the specified pull request, interactively: | ||||||
- Merge with a merge commit: | ||||||
|
||||||
`gh pr merge {{pr_number}}` | ||||||
`gh pr merge {{123}} {{[-m|--merge]}}` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- Merge the pull request, removing the branch on both the local and the remote: | ||||||
- Squash and merge, then delete the branch: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
`gh pr merge {{[-d|--delete-branch]}}` | ||||||
`gh pr merge {{123}} {{[-sd|--squash --delete-branch]}}` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- Merge the current pull request with the specified merge strategy: | ||||||
- Rebase and merge: | ||||||
|
||||||
`gh pr merge --{{merge|squash|rebase}}` | ||||||
`gh pr merge {{123}} {{[-r|--rebase]}}` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- Merge the current pull request with the specified merge strategy and commit message: | ||||||
- Enable auto-merge (squash): | ||||||
|
||||||
`gh pr merge --{{merge|squash|rebase}} {{[-t|--subject]}} {{commit_message}}` | ||||||
`gh pr merge {{123}} --auto {{[-s|--squash]}}` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
- Squash the current pull request into one commit with the message body and merge: | ||||||
- Merge with admin privileges (if allowed): | ||||||
|
||||||
`gh pr merge {{[-s|--squash]}} {{[-b|--body]}} "{{commit_message_body}}"` | ||||||
|
||||||
- Display help: | ||||||
|
||||||
`gh pr merge {{[-h|--help]}}` | ||||||
`gh pr merge {{123}} --admin` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could use some more explanation. I don't know but I'm assuming this is correct