Create

yaml

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

Create a pull request.

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

Examples

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: Workflow failed
    body: "{{ execution.id }} has failed on {{ taskrun.startDate }}. See the link below for more details"

Properties

`body`

Type: string
Dynamic: ✔️
Required: ❌

Ticket body.

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

`draft`

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

Whether to create a draft pull request.

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

`jwtToken`

Type: string
Dynamic: ✔️
Required: ❌

GitHub JWT token

Does not requires additional fields to log-in

Type: string
Dynamic: ✔️
Required: ❌

GitHub login

Requires additional field: oauthToken, to log-in

`maintainerCanModify`

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

Whether maintainers can modify the pull request.

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

`oauthToken`

Type: string
Dynamic: ✔️
Required: ❌

GitHub oauthToken

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

`repository`

Type: string
Dynamic: ✔️
Required: ❌

GitHub repository

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

`sourceBranch`

Type: string
Dynamic: ✔️
Required: ❌

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.