GitHub Data Stream Parameters

The GitHub plugin provides configurable data streams to fetch build and release data and metrics.

Each configurable data stream exposes a set of parameters that lets you filter the data you retrieve. The following information describes the available configurable data streams and their parameters in detail.

Code Scanning

Returns GitHub code scanning alerts for the repositories in scope.

Parameter
Description
State
Specify a state to filter code scanning alerts (e.g., open, closed, fixed).
Severity
Specify a severity level to filter code scanning alerts (e.g., error, warning, note).

Dependabot Alerts

Returns Dependabot alerts for vulnerable dependencies across the repositories in scope.

Parameter
Description
State
Select a state to filter by.
Severity
Select a severity to filter by.
Ecosystem
Select an ecosystem to filter by.
Scope
Select a scope to filter by.

Deployments

Returns the deployments for the selected repositories.

Parameter
Description
Environment
Select the environment to return deployments for, for example production. Leave empty to return every environment.

Issues

Returns issues across one or more organizations.

Parameter
Description
States
Enter one or more issue states to filter results by.
Result type
Select how results should be returned. Choose from:
  • List
  • Summary

Pull Requests

Returns pull requests across one or more repositories.

Parameter
Description
State
Select which pull requests are returned. Choose from:
  • All
  • Closed
  • Draft
  • Merged
  • Open

Search Query

Returns the issues and pull requests matching a GitHub search query, for when the other data streams do not narrow far enough.

Parameter
Description
Search issue query
Enter a GitHub search query to retrieve relevant issues. Use specific keywords, filters, or labels to target exactly the issues you need

Secret Scanning

Returns GitHub secret scanning alerts, flagging credentials committed into the repositories in scope.

Parameter
Description
State
Specify the status of the secret scan to filter by.
Validity
Select the verification status of the secret to filter results by.

Workflow Runs

Returns GitHub Actions workflow runs, with the outcome of each.

Parameter
Description
Workflow name
Select the exact name of the workflow to return.
Actor
Select the person, bot, or entity that triggered the workflow to filter by. Only runs initiated by this actor will be returned.
Branch
Select a branch to filter by.
Event
Specify a workflow trigger event to filter by.
Status
Select a status to filter the results by. Options typically include: queued, in_progress, completed, failed, cancelled.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket