GitHub Pull Requests Search

GitHub Pull Requests Search
Certified
Search pull requests

Runs a GitHub pull request search and writes matching pull request metadata to Kestra internal storage. Anonymous execution cannot reach private repositories and may omit fields, and authenticated runs default to CREATED sorted in ascending order.

yaml
type: io.kestra.plugin.github.pulls.Search

Examples

Search for pull requests in a repository.

yaml
id: github_pulls_search_flow
namespace: company.team

tasks:
  - id: search_pull_requests
    type: io.kestra.plugin.github.pulls.Search
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    query: "repo:kestra-io/plugin-github is:open"

Search for open pull requests in a repository.

yaml
id: github_pulls_search_flow
namespace: company.team

tasks:
  - id: search_open_pull_requests
    type: io.kestra.plugin.github.pulls.Search
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    repository: kestra-io/plugin-github
    open: TRUE

Properties

appInstallationToken string

GitHub App installation token

Installation access token generated by a GitHub App. Use this for repository-scoped app access instead of a user token.

assets

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions

io.kestra.core.models.assets.AssetsDeclaration

assetFailureBehaviorstring

Possible Values

IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

io.kestra.core.models.assets.AssetIdentifier

id*string

Min length1

typestring

outputs

The assets produced as outputs.

io.kestra.plugin.ee.assets.Dataset

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.File

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.Table

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.plugin.ee.assets.VM

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.External

id*string

Min length1

Max length150

type*object

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

io.kestra.core.models.assets.Custom

id*string

Min length1

Max length150

type*string

Min length1

Custom asset type

descriptionstring

displayNamestring

metadataobject

Default{}

namespacestring

Min length1

Max length150

assigned string

Pull requests assigned to user

Uses the assignee: qualifier for the given GitHub login

author string

Author username

Adds the author: qualifier for the given GitHub user or app

base string

Base branch filter

Adds the base: qualifier for the target branch name

closed booleanstring

Filter to closed pull requests

Adds the is: closed qualifier when set to true

closedAt string

Filter by closed date

Supports >, <, and range syntax (..) with ISO-8601 dates

commit string

Filter by commit SHA

Matches pull requests by commit SHA and requires at least seven characters

createdAt string

Filter by created date

Supports >, <, and range syntax (..) with ISO-8601 dates

createdByMe booleanstring

Only pull requests created by the caller

Adds author: @me. This option requires authenticated execution

draft booleanstring

Filter to draft pull requests

Adds the is: draft qualifier when set to true

endpoint string

GitHub API endpoint

GitHub or GitHub Enterprise API base URL such as https://api.github.com or https://ghe.acme.com/api/v3. Set this when targeting GitHub Enterprise or a non-default API endpoint.

fetchType string

DefaultSTORE

Possible Values

STOREFETCHFETCH_ONENONE

Result handling mode

Controls how hits are exposed in outputs; default STORE writes all hits to Kestra storage and returns a URI. FETCH returns all hits in the response, FETCH_ONE returns only the first hit, and NONE leaves outputs empty.

head string

Head branch filter

Adds the head: qualifier for the source branch name

jwtToken string

GitHub JWT token

GitHub App JWT used for app-level authentication. Use this when the task should authenticate as the app rather than a user.

GitHub login

GitHub login used with oauthToken for authenticated requests. Leave unset when authenticating with jwtToken or appInstallationToken.

mentions string

Mentioned user

GitHub login to use with the mentions: qualifier

merged booleanstring

Filter to merged pull requests

Adds the is: merged qualifier when set to true

oauthToken string

GitHub OAuth token

GitHub personal access token used for authenticated requests. Can be used alone or with login.

open booleanstring

Filter to open pull requests

Adds the is: open qualifier when set to true

order string

DefaultASC

Possible Values

ASCDESC

Sort direction

ASC sorts oldest first (default); DESC sorts newest first.

query string

Search keywords and qualifiers

GitHub pull request search syntax combining keywords with qualifiers like repo, is, and label

repository string

Repository to search

owner/repo value used for the repo: qualifier

reviewRequested string

Review requested from user

Matches pull requests where a review has been requested from the given GitHub username.

sort string

DefaultCREATED

Possible Values

CREATEDUPDATEDCOMMENTS

Sort field

CREATED sorts by creation time (default); UPDATED by last update; COMMENTS by comment count.

title string

Title contains text

Matches pull requests with titles containing the given text

updatedAt string

Filter by last update

Supports >, <, and range syntax (..) with ISO-8601 dates

Outputs

row object

First hit

Available only when fetchType=FETCH_ONE; contains the first hit source.

rows array

SubTypeobject

Fetched hits

Available only when fetchType=FETCH; contains hit sources for the current response page.

size integer

Returned hit count

Number of hits included in outputs for the selected fetch type.

total integer

Total hits reported

Total hits reported by GitHub search, regardless of pagination.

uri string

Formaturi

Stored hits URI

Available only when fetchType=STORE; Kestra internal storage path to the Ion file.

Canonical

Enterprise

Tasks to interact with Canonical services, enabling automation and infrastructure management through API-driven workflows.

CloudInfrastructure

Slack

Slack notification webhooks and full Slack App automations across chat, files, canvases, channels, reactions, users, and events.

Business

GitHub Pull Requests SearchCertifiedSearch pull requests

GitHub Pull Requests Search

More Plugins in this Category

Canonical

Slack

GitHub Pull Requests Search
Certified
Search pull requests