
GitHub Search
CertifiedSearch issues
GitHub Search
Search issues
Runs a GitHub issue search and writes matching issue metadata to Kestra internal storage. Anonymous execution is allowed but cannot reach private repositories and may omit fields, and authenticated runs default to CREATED sorted in ascending order.
type: io.kestra.plugin.github.issues.SearchExamples
Search for issues in a repository.
id: github_issue_search_flow
namespace: company.team
tasks:
- id: search_issues
type: io.kestra.plugin.github.issues.Search
oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
query: "repo:kestra-io/plugin-github is:open"
Search for open issues in a repository.
id: github_issue_search_flow
namespace: company.team
tasks:
- id: search_open_issues
type: io.kestra.plugin.github.issues.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.
closed booleanstring
Filter closed issues
Adds is: closed 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
STORESTOREFETCHFETCH_ONENONEResult handling mode
Controls how hits are exposed in outputs; default FETCH returns all hits in the response. FETCH_ONE returns only the first hit, STORE writes hits to Kestra storage and returns a URI, and NONE leaves outputs empty.
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.
login string
GitHub login
GitHub login used with oauthToken for authenticated requests. Leave unset when authenticating with jwtToken or appInstallationToken.
mentions string
Issues mentioning user
Adds the mentions: qualifier for the GitHub login
merged booleanstring
Filter merged pull requests
Adds is: merged when set to true. This only affects pull requests returned by issue search
oauthToken string
GitHub OAuth token
GitHub personal access token used for authenticated requests. Can be used alone or with login.
open booleanstring
Filter open issues
Adds is: open when set to true
order string
ASCASCDESCSort direction
ASC sorts ascending (default); DESC sorts descending.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
query string
Search keywords and qualifiers
GitHub issue search syntax combining keywords with qualifiers like repo, is, label.
repository string
Repository filter
owner/repo value appended as repo: when provided
sort string
CREATEDCREATEDUPDATEDCOMMENTSSort field
CREATED sorts by creation time (default); UPDATED by last update; COMMENTS by comment count.
Outputs
row object
First hit
Available only when fetchType=FETCH_ONE; contains the first hit source.
rows array
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
uriStored hits URI
Available only when fetchType=STORE; Kestra internal storage path to the Ion file.