Search

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

Search for GitHub repositories

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.repositories.Search"
id: repos
type: io.kestra.plugin.github.repositories.Search
oauthToken: your_github_token
query: "repo:kestra-io/plugin-github"

id: "search"
type: "io.kestra.plugin.github.repositories.Search"
id: repos
type: io.kestra.plugin.github.repositories.Search
oauthToken: your_github_token
repository: kestra-io/plugin-github

id: "search"
type: "io.kestra.plugin.github.repositories.Search"
id: repos
type: io.kestra.plugin.github.repositories.Search
oauthToken: your_github_token
query: "user:kestra-io language:java is:public"
sort: STARS
order: DESC

id: "search"
type: "io.kestra.plugin.github.repositories.Search"
id: repos
type: io.kestra.plugin.github.repositories.Search
oauthToken: your_github_token
user: kestra-io
language: java
visibility: PUBLIC
sort: STARS
order: DESC

Properties

created

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

Search for code based on when repository was created

jwtToken

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

GitHub JWT token

Does not requires additional fields to log-in

language

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

Search for code based on what language it's written in

Can be the language name or alias

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

Qualifiers allow you to limit your search to specific areas of GitHub

repository

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

To search the code in a specific repository

Example string: "myUserName/MyRepository". query equivalent: "repo:myUserName/MyRepository"

sort

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: UPDATED
• Possible Values:
  • UPDATED
  • STARS
  • FORKS

Sort output

UPDATED - the results will be sorted by when the repository was last updated STARS - the results will be sorted by the number of stars the repository has FORKS - the results will be sorted by the number of forks the repository has

stars

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

Search for code based on how many starts repository has

topic

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

Search the code by topic

user

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

Search the code in all repositories owned by a certain user

To search by organization use: "query: org:myOrganization"

visibility

• Type: string
• Dynamic: ❌
• Required: ❌
• Possible Values:
  • PUBLIC
  • PRIVATE
  • INTERNAL

Search repository that have specified repositories. By default it's search for all repositories

PUBLIC - shows only public repositories PRIVATE - shows only private repositories that are available for user who is searching INTERNAL - shows only internal repositories

Outputs

uri

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

Definitions