Skip to main content

Git

<Standard />

Execute as SQL style query against a github repo using mergestat-lite.

apiVersion: canaries.flanksource.com/v1
kind: Canary
metadata:
name: github-check
spec:
schedule: "@every 1m"
github:
- githubToken: <token>
query: SELECT count(*) FROM commits WHERE author_email = 'user@email.com'
FieldDescriptionSchemeRequired
queryQuery to be executed. See mergestat-lite.for more details regarding syntax.string
nameName of the check, must be unique within the canarystringYes
descriptionDescription for the checkstring
iconIcon for overwriting default icon on the dashboardstring
labelsLabels for checkmap[string]string
testEvaluate whether a check is healthyExpression
displayExpression to change the formatting of the displayExpression
transformTransform data from a check into multiple individual checksExpression
metricsMetrics to export from[]Metrics
Connection
connectionPath of an existing connection e.g. connection://github/org. Mutually exclusive with credentials
Connection
githubTokenGithub access token. EnvVarYes