Search

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

Search for GitHub pull requests

If no authentication is provided, anonymous authentication will be used. Anonymous authentication can't retrieve full information

Examples

id: "search"
type: "io.kestra.plugin.github.pulls.Search"
id: search
type: io.kestra.plugin.github.pulls.Search
oauthToken: your_github_token
query: "repo:kestra-io/plugin-github is:open"

id: "search"
type: "io.kestra.plugin.github.pulls.Search"
id: search
type: io.kestra.plugin.github.pulls.Search
oauthToken: your_github_token
repository: kestra-io/plugin-github
open: TRUE

Properties

assigned

• Type: string
• Dynamic: ❌
• Required: ❌

Search pull requests that are assigned to a certain user

author

• Type: string
• Dynamic: ❌
• Required: ❌

Finds pull requests created by a certain user or integration account

base

• Type: string
• Dynamic: ❌
• Required: ❌

Filter pull requests based on the branch they are merging into

closed

• Type: boolean
• Dynamic: ❌
• Required: ❌

Specifies whether the pull request is closed

closedAt

• Type: string
• Dynamic: ❌
• Required: ❌

Search for code based on when pull request was closed

You can use greater than, less than, and range qualifiers (.. between two dates) to further filter results

commit

• Type: string
• Dynamic: ❌
• Required: ❌

Search for pull requests that contain that SHA

The SHA syntax must be at least seven characters

createdAt

• Type: string
• Dynamic: ❌
• Required: ❌

Search for code based on when the pull request was created

You can use greater than, less than, and range qualifiers (.. between two dates) to further filter results

createdByMe

• Type: boolean
• Dynamic: ❌
• Required: ❌

Specifies whether pull request is created by user who logged in using token

Requires authentication

draft

• Type: boolean
• Dynamic: ❌
• Required: ❌

Specifies whether the pull request is in draft

head

• Type: string
• Dynamic: ❌
• Required: ❌

Filter pull requests based on the branch they came from

jwtToken

• Type: string
• Dynamic: ✔️
• Required: ❌

GitHub JWT token

Does not requires additional fields to log-in

login

• Type: string
• Dynamic: ✔️
• Required: ❌

GitHub login

Requires additional field: oauthToken, to log-in

mentions

• Type: string
• Dynamic: ✔️
• Required: ❌

Searched issues mentions by specified user

merged

• Type: boolean
• Dynamic: ❌
• Required: ❌

Specifies whether the pull request is merged

oauthToken

• Type: string
• Dynamic: ✔️
• Required: ❌

GitHub oauthToken

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

open

• Type: boolean
• Dynamic: ❌
• Required: ❌

Specifies whether the pull request is open

order

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: ASC
• Possible Values:
  • ASC
  • DESC

Order output

ASC - the results will be in ascending order DESC - the results will be in descending order

query

• Type: string
• Dynamic: ✔️
• Required: ❌

The query contains one or more search keywords and qualifiers

Allow you to limit your search to specific areas of GitHub

repository

• Type: string
• Dynamic: ❌
• Required: ❌

Search pull requests in a specific repository

sort

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: CREATED
• Possible Values:
  • CREATED
  • UPDATED
  • COMMENTS

Sort output

CREATED - Sorts the results of query by the time issue was created (DEFAULT) UPDATED - Sorts the results of query by the tome issue was last time updated COMMENTS - Sorts the results of query by the number of comments

title

• Type: string
• Dynamic: ❌
• Required: ❌

Search pull requests that have title like specified

updatedAt

• Type: string
• Dynamic: ❌
• Required: ❌

Search for code based on when pull request was updated last time

You can use greater than, less than, and range qualifiers (.. between two dates) to further filter results

Outputs

uri

• Type: string
• Dynamic: ❓
• Required: ❌
• Format: uri

Definitions