1. Docs
2. /
3. Tool reference
4. /
5. GitHub & Code
6. /
7. openPullRequest

GitHub & Code

openPullRequest

Open Pull Request

Open a pull request on a connected GitHub repo.

writeexternal

Arguments

• accountstringoptionalConnected GitHub login to act as. Defaults to the Primary account.
• basestringrequiredThe branch to merge into (e.g. main: the PR target)
• bodystringoptionalPR body (markdown)
• citationRefstringoptionalThe BuildDoc, Task, or ticket this PR implements, as the signature's leading cite chip. Pass a CLOUD-### id or a BuildDoc, Task, or ticket URL. It is linkified. Anything that cannot resolve to a link is omitted rather than printed.
• headstringrequiredThe feature branch with the changes
• ownerstringrequiredRepository owner
• repostringrequiredRepository name
• titlestringrequiredPR title

Returns

The registry does not declare a return shape.

Ask for it

The Cloud routes these requests to this verb.

• open a PR
• raise a pull request

Pair it with

The verbs that finish the job.

• createBranch
• commitFiles
• reviewPullRequest
• mergePullRequest