Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions pages/common/gh-pr-checks.md
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`
26 changes: 11 additions & 15 deletions pages/common/gh-pr-merge.md
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:
Copy link
Member

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

Suggested change
- Merge with a merge commit:
- Merge the current branch into the specified pull request:


`gh pr merge {{pr_number}}`
`gh pr merge {{123}} {{[-m|--merge]}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`gh pr merge {{123}} {{[-m|--merge]}}`
`gh pr merge {{pr_number}} {{[-m|--merge]}}`


- Merge the pull request, removing the branch on both the local and the remote:
- Squash and merge, then delete the branch:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Squash and merge, then delete the branch:
- Squash and merge a pull request, then delete the branch:


`gh pr merge {{[-d|--delete-branch]}}`
`gh pr merge {{123}} {{[-sd|--squash --delete-branch]}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`gh pr merge {{123}} {{[-sd|--squash --delete-branch]}}`
`gh pr merge {{pr_number}} {{[-sd|--squash --delete-branch]}}`


- 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]}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`gh pr merge {{123}} {{[-r|--rebase]}}`
`gh pr merge {{pr_number}} {{[-r|--rebase]}}`


- 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]}}`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`gh pr merge {{123}} --auto {{[-s|--squash]}}`
`gh pr merge {{pr_number}} --auto {{[-s|--squash]}}`


- 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`