Search

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

Search for GitHub code.

Requires authentication.

Examples

Search for code in a repository.

id: github_code_search_flow
namespace: company.team

tasks:
  - id: search_code
    type: io.kestra.plugin.github.code.Search
    oauthToken: your_github_token
    query: "addClass in:file language:js repo:jquery/jquery"

Search for code in a repository.

id: github_code_search_flow
namespace: company.team

tasks:
  - id: search_code
    type: io.kestra.plugin.github.code.Search
    oauthToken: your_github_token
    query: addClass
    in: file
    language: js
    repository: jquery/jquery

Properties

extension

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

The file extension.

filename

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

The file name.

fork

• Type: string
• Dynamic: ❌
• Required: ❌
• Possible Values:
  • PARENT_AND_FORKS
  • FORKS_ONLY
  • PARENT_ONLY

Whether to include forks.

in

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

In

jwtToken

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

GitHub JWT token

Does not requires additional fields to log-in

language

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

The language.

login

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

GitHub login

Requires additional field: oauthToken, to log-in

oauthToken

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

GitHub oauthToken

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

order

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

Order of the output.

ASC - the results will be in ascending order

DESC - the results will be in descending order

path

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

The file path.

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: ❌

The GitHub repository.

size

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

The file size.

sort

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: BEST_MATCH
• Possible Values:
  • BEST_MATCH
  • INDEXED

Sort condition for the output.

BEST_MATCH - the results will be sorted by best match results

INDEXED - the results will be sorted by the index

user

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

Search commits in all repositories owned by a certain user.

Outputs

uri

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

Definitions