From 21e47868cbb70f9825e40d70e6caad664965a4cc Mon Sep 17 00:00:00 2001 From: Meredith Lancaster Date: Fri, 9 Jan 2026 11:27:06 -0800 Subject: [PATCH] add section on artifact storage records Signed-off-by: Meredith Lancaster --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 98c7c73..b8e9a62 100644 --- a/README.md +++ b/README.md @@ -253,9 +253,15 @@ the specific image being attested is identified by the supplied digest. Attestation bundles are stored in the OCI registry according to the [Cosign Bundle Specification][10]. +#### Artifact Metadata Storage Records + If the `push-to-registry` option is set to true, the Action will also -emit an Artifact Metadata Storage Record. If you do not want to emit a -storage record, set `create-storage-record` to `false`. +emit an [Artifact Metadata Storage Record](https://docs.github.com/en/rest/orgs/artifact-metadata?apiVersion=2022-11-28#create-artifact-metadata-storage-record). +Storage records enrich artifact metadata by capturing storage +related details, such as which registry an image is hosted on +and whether its still active on that registry. + +If you do not want to emit a storage record, set `create-storage-record` to `false`. > **NOTE**: When pushing to Docker Hub, please use "index.docker.io" as the > registry portion of the image name.