gh-pr-checks: add pages; gh-pr-merge: update page #18506
+31
−15
Conversation
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
|
|
github-actions
bot
added
new command
Managor
changed the title
gh pr checks and gh pr merge tldr pages
Managor
changed the title
Managor
changed the title
dmmqz
changed the title
dmmqz
reviewed
Oct 6, 2025
…example - Remove "Part of the GitHub CLI" line from both pages - Restore interactive merge example as first example in gh-pr-merge - Update flags to show both short and long forms: [-m|--merge], [-sd|--squash --delete-branch], [-r|--rebase], [-s|--squash] - Merge short options where applicable (e.g., -sd for -s -d) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Managor
requested changes
Oct 7, 2025
| `gh pr merge` | ||
|
|
||
| - Merge the specified pull request, interactively: | ||
| - Merge with a merge commit: |
There was a problem hiding this comment.
This could use some more explanation. I don't know but I'm assuming this is correct
Suggested change
| - Merge with a merge commit: | |
| - Merge the current branch into the specified pull request: |
| - Merge with a merge commit: | ||
|
|
||
| `gh pr merge {{pr_number}}` | ||
| `gh pr merge {{123}} {{[-m|--merge]}}` |
There was a problem hiding this comment.
Suggested change
| `gh pr merge {{123}} {{[-m|--merge]}}` | |
| `gh pr merge {{pr_number}} {{[-m|--merge]}}` |
| `gh pr merge {{123}} {{[-m|--merge]}}` | ||
|
|
||
| - 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.
Suggested change
| - Squash and merge, then delete the branch: | |
| - Squash and merge a pull request, then delete the branch: |
| - Squash and merge, then delete the branch: | ||
|
|
||
| `gh pr merge {{[-d|--delete-branch]}}` | ||
| `gh pr merge {{123}} {{[-sd|--squash --delete-branch]}}` |
There was a problem hiding this comment.
Suggested change
| `gh pr merge {{123}} {{[-sd|--squash --delete-branch]}}` | |
| `gh pr merge {{pr_number}} {{[-sd|--squash --delete-branch]}}` |
| - Rebase and merge: | ||
|
|
||
| `gh pr merge --{{merge|squash|rebase}}` | ||
| `gh pr merge {{123}} {{[-r|--rebase]}}` |
There was a problem hiding this comment.
Suggested change
| `gh pr merge {{123}} {{[-r|--rebase]}}` | |
| `gh pr merge {{pr_number}} {{[-r|--rebase]}}` |
| - 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.
Suggested change
| `gh pr merge {{123}} --auto {{[-s|--squash]}}` | |
| `gh pr merge {{pr_number}} --auto {{[-s|--squash]}}` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add two GitHub CLI pages:
gh pr checks: view and watch CI checks (--watch,--required).gh pr merge: common merge strategies (--merge,--squash --delete-branch,--rebase,--auto,--admin).All examples follow the tldr style and pass
tldrl.Validation:
tldrlon both files → no issues.ghcommand documentation.