GitHub Search
CertifiedSearch commits
GitHub Search
Search commits
Runs a GitHub commit search and writes matching commit metadata to Kestra internal storage. Anonymous execution returns an empty output, and authenticated runs default to COMMITTER_DATE sorted in ascending order.
type: io.kestra.plugin.github.commits.SearchExamples
Search for commits in a repository.
id: github_commit_search_flow
namespace: company.team
tasks:
- id: search_commit
type: io.kestra.plugin.github.commits.Search
oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
query: "Initial repo:kestra-io/plugin-github language:java"
Search for commits in a repository.
id: github_commit_search_flow
namespace: company.team
tasks:
- id: search_commit
type: io.kestra.plugin.github.commits.Search
oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
query: Initial
repository: kestra-io/plugin-github
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.
committer string
Committer login
Adds the committer: qualifier for the GitHub login
committerDate string
Committer date filter
Supports >, <, and range (..) date syntax
committerEmail string
Committer email
Filters by committer email address
committerName string
Committer name
Filters by committer display name
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
STORESTOREFETCHFETCH_ONENONEResult 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.
hash string
Commit SHA filter
Matches commits with the specified SHA-1 hash
is string
Repository visibility
Value used for the is: qualifier such as public or private
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.
login string
GitHub login
GitHub login used with oauthToken for authenticated requests. Leave unset when authenticating with jwtToken or appInstallationToken.
merge booleanstring
Filter merge commits
When set, includes only merge commits for true or excludes them for false
oauthToken string
GitHub OAuth token
GitHub personal access token used for authenticated requests. Can be used alone or with login.
order string
ASCASCDESCSort direction
ASC sorts ascending (default); DESC sorts descending.
org string
Organization scope
Limits the search to repositories owned by the given organization
parent string
Parent commit SHA
Filters by parent commit SHA-1
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
query string
Search keywords and qualifiers
Commit search syntax combining keywords with qualifiers like repo, author, path.
repository string
Repository to search
owner/repo value used for the repo: qualifier
sort string
COMMITTER_DATECOMMITTER_DATEAUTHOR_DATESort field
COMMITTER_DATE sorts by committer timestamp (default); AUTHOR_DATE by author timestamp.
tree string
Tree SHA filter
Filters by Git tree SHA-1
user string
User scope
Limits the search to repositories owned by the given user
Outputs
row object
First hit
Available only when fetchType=FETCH_ONE; contains the first hit source.
rows array
Fetched hits
Available only when fetchType=FETCH; contains hit sources for the current response page.
size integer
Returned hit count
Number of hits included in outputs for the selected fetch type.
total integer
Total hits reported
Total hits reported by GitHub search, regardless of pagination.
uri string
uriStored hits URI
Available only when fetchType=STORE; Kestra internal storage path to the Ion file.
