Search

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

Search for GitHub code

Requires authentication

Examples

yaml
id: "search"
type: "io.kestra.plugin.github.code.Search"
id: search
type: io.kestra.plugin.github.code.Search
oauthToken: your_github_token
query: "addClass in:file language:js repo:jquery/jquery"
yaml
id: "search"
type: "io.kestra.plugin.github.code.Search"
id: search
type: io.kestra.plugin.github.code.Search
oauthToken: your_github_token
query: addClass
in: file
language: js
repository: jquery/jquery

Properties

Order output

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

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

Sort output

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

BEST_MATCH - the results will be sorted by best match results INDEXED - the results will be sorted by the index

Whether to include forks

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

extension

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

The file extension

filename

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

The file name

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

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 path

user

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

Search commits in all repositories owned by a certain user

Outputs

uri

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

Definitions

Was this page helpful?