PluginsGitHubTasksCommitsSearch

Search​Search

Search Search

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

Search for GitHub commits.

Requires authentication.

Examples

Search for commits in a repository.

yaml
id: github_commit_search_flow
namespace: company.team

tasks:
  - id: search_commit
    type: io.kestra.plugin.github.commits.Search
    oauthToken: your_github_token
    query: "Initial repo:kestra-io/plugin-github language:java"

Search for commits in a repository.

yaml
id: github_commit_search_flow
namespace: company.team

tasks:
  - id: search_commit
    type: io.kestra.plugin.github.commits.Search
    oauthToken: your_github_token
    query: Initial
    repository: kestra-io/plugin-github

Properties

author

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

Find commits by a particular user.

authorDate

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

Match commits authored within the specified date range. When you search for a date, you can use greater than, less than, and range qualifiers to further filter results.

authorEmail

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

Match commits by the author's full email address.

authorName

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

Match commits by the name of the author

committer

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

Find commits by a particular user

committerDate

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

Match commits committed within the specified date range.

When you search for a date, you can use greater than, less than, and range qualifiers to further filter results.

committerEmail

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

Match commits by the committer's full email address.

committerName

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

Match commits by the name of the committer

hash

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

Matches commits with the specified SHA-1 hash.

is

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

Matches commits from repositories with the specified visibility.

jwtToken

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

GitHub JWT token

Does not requires additional fields to log-in

login

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

GitHub login

Requires additional field: oauthToken, to log-in

merge

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Whether to filter merge commits.

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

org

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

Search commits in all repositories owned by a certain organization.

parent

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

Matches commits whose parent has the specified SHA-1 hash.

query

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

The query contains one or more search keywords and qualifiers.

Allows you to limit your search to specific areas of GitHub.

repository

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

Search in specified repository.

sort

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: COMMITTER_DATE
  • Possible Values:
    • COMMITTER_DATE
    • AUTHOR_DATE

Sort condition for the output.

COMMITTER_DATE - the results will be sorted by when user joined to Github

AUTHOR_DATE - the results will be sorted by the number of repositories owned by user

tree

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

Matches commits with the specified SHA-1 git tree hash.

user

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

Search commits in all repositories owned by a certain user

Outputs

uri

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

Definitions

Was this page helpful?