Prints the check’s resolved definition and the digest that evidence for it must name.
Usage
overlane ci check show checkArguments
| Argument | Required | Description |
|---|---|---|
check |
yes | The check ID, snake_case, as tasks name it in requiredChecks |
Examples
overlane ci check show unit_testsBehavior
- Effect:
read(changes nothing). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: no. Accepts--force: no. - Machine-readable description:
overlane schema ci check show.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
"description": "tenant identifier"
},
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
"description": "project identifier"
},
"checkId": {
"type": "string",
"maxLength": 128,
"pattern": "^[a-z][a-z0-9_]*$"
},
"definition": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "argv"
},
"argv": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1000
}
},
"image": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"toolVersions": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"additionalProperties": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
},
"required": [
"kind",
"argv",
"image",
"toolVersions"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "workflow-job"
},
"provider": {
"type": "string",
"enum": [
"overlane",
"github",
"gitlab"
]
},
"workflow": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"job": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"spec": {},
"image": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"toolVersions": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"additionalProperties": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
},
"required": [
"kind",
"provider",
"workflow",
"job",
"spec",
"image",
"toolVersions"
],
"additionalProperties": false
}
]
},
"definitionDigest": {
"type": "string",
"pattern": "^sha256:[0-9a-f]{64}$"
},
"registeredAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"registeredBy": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"tenantId",
"projectId",
"checkId",
"definition",
"definitionDigest",
"registeredAt",
"registeredBy"
],
"additionalProperties": false
}See exit codes for the status the process returns.