Skip to content

Commit 6865550

Browse files
malancasCopilotbdehamer
authored
Add more documentation on Artifact Metadata Storage Records (#797)
* add section on artifact storage records Signed-off-by: Meredith Lancaster <malancas@github.com> * reorganize storage record section Signed-off-by: Meredith Lancaster <malancas@github.com> * add additional requirements for record generation Signed-off-by: Meredith Lancaster <malancas@github.com> * typo Signed-off-by: Meredith Lancaster <malancas@github.com> * wording Signed-off-by: Meredith Lancaster <malancas@github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * lines should not exceed 80 characters Signed-off-by: Meredith Lancaster <malancas@github.com> * Update README.md Co-authored-by: Brian DeHamer <bdehamer@github.com> * line wrapping linting Signed-off-by: Meredith Lancaster <malancas@github.com> --------- Signed-off-by: Meredith Lancaster <malancas@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Brian DeHamer <bdehamer@github.com>
1 parent 98f3aa9 commit 6865550

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,10 +253,6 @@ the specific image being attested is identified by the supplied digest.
253253
Attestation bundles are stored in the OCI registry according to the [Cosign
254254
Bundle Specification][10].
255255

256-
If the `push-to-registry` option is set to true, the Action will also
257-
emit an Artifact Metadata Storage Record. If you do not want to emit a
258-
storage record, set `create-storage-record` to `false`.
259-
260256
> **NOTE**: When pushing to Docker Hub, please use "index.docker.io" as the
261257
> registry portion of the image name.
262258

@@ -304,6 +300,25 @@ jobs:
304300
push-to-registry: true
305301
```
306302

303+
#### Artifact Metadata Storage Records
304+
305+
If the `push-to-registry` option is set to true, the Action will also
306+
emit an [Artifact Metadata Storage Record](https://docs.github.com/en/rest/orgs/artifact-metadata?apiVersion=2022-11-28#create-artifact-metadata-storage-record).
307+
Storage records enrich artifact metadata by capturing storage
308+
related details, such as which registry an image is hosted on
309+
and whether it's marked as active.
310+
311+
If you do not want to emit a storage record, set `create-storage-record` to `false`.
312+
313+
> **NOTE**: Storage records can only be created for artifacts
314+
> built from [organization-owned](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations)
315+
> repositories.
316+
317+
Artifacts associated with a storage record can be viewed by navigating to
318+
the `Linked Artifacts` page in your organization:
319+
`https://github.com/orgs/YOUR_ORG/artifacts`
320+
(replace `YOUR_ORG` with your organization name).
321+
307322
### Integration with `actions/upload-artifact`
308323

309324
If you'd like to create an attestation for an archive created with the

0 commit comments

Comments
 (0)