GitHub Search

GitHub Search
Certified
Search topics

Runs a GitHub topic search and writes matching topic metadata to Kestra internal storage. The task calls the REST API directly so it can honor custom endpoints and token types, and defaults to ascending order.

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

Examples

Search for topics.

yaml
id: github_topic_search_flow
namespace: company.team

tasks:
  - id: search_topics
    type: io.kestra.plugin.github.topics.Search
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    query: "micronaut framework is:not-curated repositories:>100"

Search for topics with conditions.

yaml
id: github_topic_search_flow
namespace: company.team

tasks:
  - id: search_topics
    type: io.kestra.plugin.github.topics.Search
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    query: "micronaut framework"
    is: NOT_CURATED
    repositories: ">100"

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.

created string

Created date filter

Supports >, <, and range (..) date syntax

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 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.

is string

Possible Values

CURATEDFEATUREDNOT_CURATEDNOT_FEATURED

Curation/feature flags

CURATED matches curated topics

FEATURED matches topics featured on https://github.com/topics/

NOT_CURATED excludes curated topics

NOT_FEATURED excludes featured topics

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.

oauthToken string

GitHub OAuth token

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

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

query string

Search keywords and qualifiers

GitHub topic search syntax combining keywords with qualifiers. Note: GitHub's topic search API does not support sorting - results are always returned in best match order.

repositories string

Repository count filter

Supports >, <, and range (..) qualifiers

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