-
-
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
Open
Golenspade
wants to merge
2
commits into
tldr-pages:main
Choose a base branch
from
Golenspade:docs/gh-pr-checks-merge
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+31
−15
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# gh pr checks | ||
|
||
> View CI checks for a GitHub pull request. | ||
> Part of the GitHub CLI: `gh`. | ||
> 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` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,32 +1,25 @@ | ||||||
# gh pr merge | ||||||
|
||||||
> Merge GitHub pull requests. | ||||||
> Merge a GitHub pull request. | ||||||
> Part of the GitHub CLI: `gh`. | ||||||
Managor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
> More information: <https://cli.github.com/manual/gh_pr_merge>. | ||||||
- Merge the pull request associated with the current branch interactively: | ||||||
- Merge with a merge commit: | ||||||
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. This could use some more explanation. I don't know but I'm assuming this is correct
Suggested change
|
||||||
|
||||||
`gh pr merge` | ||||||
Managor marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
`gh pr merge {{123}} --merge` | ||||||
Managor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
||||||
- Merge the specified pull request, interactively: | ||||||
- 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 {{pr_number}}` | ||||||
`gh pr merge {{123}} --squash --delete-branch` | ||||||
Managor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
||||||
- Merge the pull request, removing the branch on both the local and the remote: | ||||||
- Rebase and merge: | ||||||
|
||||||
`gh pr merge {{[-d|--delete-branch]}}` | ||||||
`gh pr merge {{123}} --rebase` | ||||||
Managor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
||||||
- Merge the current pull request with the specified merge strategy: | ||||||
- Enable auto-merge (squash): | ||||||
|
||||||
`gh pr merge --{{merge|squash|rebase}}` | ||||||
`gh pr merge {{123}} --auto --squash` | ||||||
Managor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
||||||
- Merge the current pull request with the specified merge strategy and commit message: | ||||||
- Merge with admin privileges (if allowed): | ||||||
|
||||||
`gh pr merge --{{merge|squash|rebase}} {{[-t|--subject]}} {{commit_message}}` | ||||||
|
||||||
- Squash the current pull request into one commit with the message body and merge: | ||||||
|
||||||
`gh pr merge {{[-s|--squash]}} {{[-b|--body]}} "{{commit_message_body}}"` | ||||||
|
||||||
- Display help: | ||||||
|
||||||
`gh pr merge {{[-h|--help]}}` | ||||||
`gh pr merge {{123}} --admin` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.