diff --git a/docs/attestations/README.md b/docs/attestations/README.md new file mode 100644 index 000000000000..b4e4c1e76449 --- /dev/null +++ b/docs/attestations/README.md @@ -0,0 +1,16 @@ +# Attestations + +BuildKit supports creating and attaching attestations to build artifacts. +Generated attestations use the [in-toto attestation format](https://github.com/in-toto/attestation). + +The currently supported attestation types are: + +- [SBOMs](./sbom.md) +- [SLSA Provenance](./slsa-provenance.md) + +Upon generation, attestations are attached differently to the export result: + +- For the `image`, `oci` and `docker` exporters, attestations are exported + using the attached [attestation storage](./attestation-storage.md). +- For the `local` and `tar` exporters, attestations are written to separate + files within the output directory. diff --git a/docs/attestation-storage.md b/docs/attestations/attestation-storage.md similarity index 100% rename from docs/attestation-storage.md rename to docs/attestations/attestation-storage.md diff --git a/docs/sbom-protocol.md b/docs/attestations/sbom-protocol.md similarity index 100% rename from docs/sbom-protocol.md rename to docs/attestations/sbom-protocol.md diff --git a/docs/sbom.md b/docs/attestations/sbom.md similarity index 100% rename from docs/sbom.md rename to docs/attestations/sbom.md diff --git a/docs/slsa-definitions.md b/docs/attestations/slsa-definitions.md similarity index 100% rename from docs/slsa-definitions.md rename to docs/attestations/slsa-definitions.md diff --git a/docs/slsa-provenance.md b/docs/attestations/slsa-provenance.md similarity index 100% rename from docs/slsa-provenance.md rename to docs/attestations/slsa-provenance.md