kusaridev/Kusari Ingest

Ingest files into Kusari Platform

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
file-pathPath to directory or specific file to ingest. Required when generate is false; must be empty when generate is true (the action uploads the generated SBOM).no""
generateGenerate an SBOM with `kusari platform generate` (via waybill) and upload it, instead of uploading an existing file.nofalse
source-pathSource path to scan when generate is true. Passed to waybill as `--path`. Exactly one of `source-path` or `image` is required when generate is true.no""
imageContainer image reference (OCI ref or `docker save` tarball path) to scan when generate is true. Passed to waybill as `--image`. Exactly one of `source-path` or `image` is required when generate is true.no""
output-pathPath where the generated SBOM is written (used when generate is true). Passed to waybill as `--output` and then used as the file to upload. Default matches waybill's CycloneDX default.noproject.cdx.json
waybill-argsAdditional flags passed verbatim to `waybill sbom scan` after `--` when generate is true. Avoid overriding `--output` here; use the `output-path` input instead.no""
mikebom-argsDEPRECATED: mikebom was renamed to waybill; use `waybill-args` instead. Treated exactly like `waybill-args`, but ignored when `waybill-args` is also set. Will be removed in a future release.no""
root-namewaybill `--root-name` value used when generate is true. When unset, waybill uses its own auto-derivation.no""
root-versionwaybill `--root-version` value used when generate is true. When unset, waybill uses its own auto-derivation.no""
no-root-purlWhen "true" and generate is true, pass `--no-root-purl` so waybill emits no root purl. The resulting software has an empty pkg_type (matches syft container-image rows).nofalse
tenant-endpointKusari Platform tenant api endpointyes
client-idClient id for auth token provideryes
client-secretClient secret for auth token provideryes
token-endpointKusari Platform auth token provider endpointyeshttps://auth.us.kusari.cloud/oauth2/token
console-urlInternal use only. Console URL override for non-production (e.g. dev) environments. Leave unset for production.no""
platform-urlInternal use only. Platform API URL override for non-production (e.g. dev) environments. Leave unset for production.no""
aliasDEPRECATED: not used by the Kusari platform; will be removed in a future releaseno""
document-typeType of the file being uploadedno""
open-vexSet to true if ingesting an OpenVEX document. When true, tag is required and so is one of software-id and sbom-subject.nofalse
tagTag for the document. Currently only used for OpenVEX. Example: govulncheckno
software-idKusari Platform software ID that the document applies to. Currently only used for OpenVEX. Example: 1234no
sbom-subjectKusari Platform software SBOM subject substring value that uniquely indicates which software that the document applies to. Currently only used for OpenVex. Example: kusari-ingestno
check-blocked-packagesCheck SBOM dependencies against the Blocked Package list in the Kusari Platform.nofalse
sbom-subject-name-overrideSBOM Subject Name override (optional, for SBOMs only)no""
sbom-subject-version-overrideSBOM Subject Version override (optional, for SBOMs only)no""
commit-shaCommit SHA to associate with the uploaded document (optional)no${{ github.sha }}
waitWait for ingestion status (default: true)notrue
results-filePath to write the machine-readable JSON ingestion results to (software and component IDs per ingested SBOM). Setting this (or map-components) also populates the `results` output; when neither is set the ID lookups are skipped entirely. Requires wait: true.no""
map-componentsWhen "true", passes --map-components to the kusari CLI: after ingestion, each ingested software not already mapped to a Kusari component gets mapped automatically — create (or reuse) a component named after the software and assign the software to it. Requires wait: true (the default).nofalse
namedescription
console_outKusari Platform ingestion output
resultsContents of the ingestion results JSON ({"sboms": [...]} with software/component IDs per ingested SBOM). Populated only when the results-file input is set or map-components is true; empty otherwise. When map-components is true, reflects the final post-mapping state.