Skip to content

Commit 535fbff

Browse files
committed
generate cli docs
Signed-off-by: Jose I. Paris <jiparis@chainloop.dev>
1 parent cac2199 commit 535fbff

2 files changed

Lines changed: 25 additions & 5 deletions

File tree

app/cli/documentation/cli-reference.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Options
246246
--annotation strings additional annotation in the format of key=value
247247
--attestation-id string Unique identifier of the in-progress attestation
248248
-h, --help help for add
249-
--kind string kind of the material to be recorded: ["ARTIFACT" "ATTESTATION" "BLACKDUCK_SCA_JSON" "CHAINLOOP_AI_AGENT_CONFIG" "CHAINLOOP_PR_INFO" "CHAINLOOP_RUNNER_CONTEXT" "CONTAINER_IMAGE" "CSAF_INFORMATIONAL_ADVISORY" "CSAF_SECURITY_ADVISORY" "CSAF_SECURITY_INCIDENT_RESPONSE" "CSAF_VEX" "EVIDENCE" "GHAS_CODE_SCAN" "GHAS_DEPENDENCY_SCAN" "GHAS_SECRET_SCAN" "GITLAB_SECURITY_REPORT" "GITLEAKS_JSON" "HELM_CHART" "JACOCO_XML" "JUNIT_XML" "OPENVEX" "SARIF" "SBOM_CYCLONEDX_JSON" "SBOM_SPDX_JSON" "SLSA_PROVENANCE" "STRING" "TWISTCLI_SCAN_JSON" "ZAP_DAST_ZIP"]
249+
--kind string kind of the material to be recorded: ["ARTIFACT" "ATTESTATION" "BLACKDUCK_SCA_JSON" "CHAINLOOP_AI_AGENT_CONFIG" "CHAINLOOP_AI_CODING_SESSION" "CHAINLOOP_PR_INFO" "CHAINLOOP_RUNNER_CONTEXT" "CONTAINER_IMAGE" "CSAF_INFORMATIONAL_ADVISORY" "CSAF_SECURITY_ADVISORY" "CSAF_SECURITY_INCIDENT_RESPONSE" "CSAF_VEX" "EVIDENCE" "GHAS_CODE_SCAN" "GHAS_DEPENDENCY_SCAN" "GHAS_SECRET_SCAN" "GITLAB_SECURITY_REPORT" "GITLEAKS_JSON" "HELM_CHART" "JACOCO_XML" "JUNIT_XML" "OPENVEX" "SARIF" "SBOM_CYCLONEDX_JSON" "SBOM_SPDX_JSON" "SLSA_PROVENANCE" "STRING" "TWISTCLI_SCAN_JSON" "ZAP_DAST_ZIP"]
250250
--name string name of the material as shown in the contract
251251
--no-strict-validation skip strict schema validation for SBOM_CYCLONEDX_JSON materials
252252
--registry-password string registry password, ($CHAINLOOP_REGISTRY_PASSWORD)
@@ -2934,7 +2934,7 @@ Options
29342934
--annotation strings Key-value pairs of material annotations (key=value)
29352935
-h, --help help for eval
29362936
--input stringArray Key-value pairs of policy inputs (key=value)
2937-
--kind string Kind of the material: ["ARTIFACT" "ATTESTATION" "BLACKDUCK_SCA_JSON" "CHAINLOOP_AI_AGENT_CONFIG" "CHAINLOOP_PR_INFO" "CHAINLOOP_RUNNER_CONTEXT" "CONTAINER_IMAGE" "CSAF_INFORMATIONAL_ADVISORY" "CSAF_SECURITY_ADVISORY" "CSAF_SECURITY_INCIDENT_RESPONSE" "CSAF_VEX" "EVIDENCE" "GHAS_CODE_SCAN" "GHAS_DEPENDENCY_SCAN" "GHAS_SECRET_SCAN" "GITLAB_SECURITY_REPORT" "GITLEAKS_JSON" "HELM_CHART" "JACOCO_XML" "JUNIT_XML" "OPENVEX" "SARIF" "SBOM_CYCLONEDX_JSON" "SBOM_SPDX_JSON" "SLSA_PROVENANCE" "STRING" "TWISTCLI_SCAN_JSON" "ZAP_DAST_ZIP"]
2937+
--kind string Kind of the material: ["ARTIFACT" "ATTESTATION" "BLACKDUCK_SCA_JSON" "CHAINLOOP_AI_AGENT_CONFIG" "CHAINLOOP_AI_CODING_SESSION" "CHAINLOOP_PR_INFO" "CHAINLOOP_RUNNER_CONTEXT" "CONTAINER_IMAGE" "CSAF_INFORMATIONAL_ADVISORY" "CSAF_SECURITY_ADVISORY" "CSAF_SECURITY_INCIDENT_RESPONSE" "CSAF_VEX" "EVIDENCE" "GHAS_CODE_SCAN" "GHAS_DEPENDENCY_SCAN" "GHAS_SECRET_SCAN" "GITLAB_SECURITY_REPORT" "GITLEAKS_JSON" "HELM_CHART" "JACOCO_XML" "JUNIT_XML" "OPENVEX" "SARIF" "SBOM_CYCLONEDX_JSON" "SBOM_SPDX_JSON" "SLSA_PROVENANCE" "STRING" "TWISTCLI_SCAN_JSON" "ZAP_DAST_ZIP"]
29382938
--material string Path to material or attestation file
29392939
-p, --policy string Policy reference (./my-policy.yaml, https://my-domain.com/my-policy.yaml, chainloop://my-stored-policy) (default "policy.yaml")
29402940
```

internal/schemavalidators/internal_schemas/prinfo/pr-info-1.2.schema.json

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,28 @@
4444
"description": "Direct URL to the PR/MR"
4545
},
4646
"author": {
47-
"type": "string",
48-
"description": "Username of the PR/MR author"
47+
"properties": {
48+
"login": {
49+
"type": "string",
50+
"description": "Username of the PR/MR author"
51+
},
52+
"type": {
53+
"type": "string",
54+
"enum": [
55+
"User",
56+
"Bot",
57+
"unknown"
58+
],
59+
"description": "Account type of the PR/MR author"
60+
}
61+
},
62+
"additionalProperties": false,
63+
"type": "object",
64+
"required": [
65+
"login",
66+
"type"
67+
],
68+
"description": "The PR/MR author"
4969
},
5070
"reviewers": {
5171
"items": {
@@ -101,4 +121,4 @@
101121
],
102122
"title": "Pull Request / Merge Request Information",
103123
"description": "Schema for Pull Request or Merge Request metadata collected during attestation"
104-
}
124+
}

0 commit comments

Comments
 (0)