diff --git a/pages/common/gh-pr-checks.md b/pages/common/gh-pr-checks.md new file mode 100644 index 00000000000000..0f21f133cfc9b2 --- /dev/null +++ b/pages/common/gh-pr-checks.md @@ -0,0 +1,20 @@ +# gh pr checks + +> View CI checks for a GitHub pull request. +> More information: . + +- 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` diff --git a/pages/common/gh-pr-merge.md b/pages/common/gh-pr-merge.md index 9be6ead07fa3e1..ca1f37da7c9ecc 100644 --- a/pages/common/gh-pr-merge.md +++ b/pages/common/gh-pr-merge.md @@ -1,32 +1,28 @@ # gh pr merge -> Merge GitHub pull requests. +> Merge a GitHub pull request. > More information: . - 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]}}` -- Merge the pull request, removing the branch on both the local and the remote: +- Squash and merge, then delete the branch: -`gh pr merge {{[-d|--delete-branch]}}` +`gh pr merge {{123}} {{[-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]}}` -- 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]}}` -- 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`