Create a GitHub pull request.

If no authentication is provided, anonymous authentication will be used.

yaml
type: "io.kestra.plugin.github.pulls.Create"

Create a pull request in a repository.

yaml
id: github_pulls_create_flow
namespace: company.team

tasks:
  - id: create_pull_request
    type: io.kestra.plugin.github.pulls.Create
    oauthToken: your_github_token
    repository: kestra-io/kestra
    sourceBranch: develop
    targetBranch: main
    title: Merge develop to main
    body: "Request to merge changes from develop into main"
Properties

Ticket body.

The contents of the pull request. This is the markdown description of a pull request.

Default false

Whether to create a draft pull request.

Boolean value indicates whether to create a draft pull request or not. Default is false.

GitHub JWT token

Does not requires additional fields to log-in

GitHub login

Requires additional field: oauthToken, to log-in

Default false

Whether maintainers can modify the pull request.

Boolean value indicating whether maintainers can modify the pull request. Default is false.

GitHub oauthToken

GitHub Personal Access Token. In addition, can be used with login or by its own

GitHub repository

Repository where issue/ticket should be created. It's a string of Username + / + Repository name

Source/Head branch.

Required. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username: branch.

Target/Base branch.

Required. The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.

Ticket title.

Required. The title of the pull request.