mirror of
https://github.com/actions/attest-build-provenance.git
synced 2026-06-15 11:09:54 +00:00
reorganize storage record section
Signed-off-by: Meredith Lancaster <malancas@github.com>
This commit is contained in:
parent
21e47868cb
commit
4790ff9334
20
README.md
20
README.md
@ -253,16 +253,6 @@ the specific image being attested is identified by the supplied digest.
|
|||||||
Attestation bundles are stored in the OCI registry according to the [Cosign
|
Attestation bundles are stored in the OCI registry according to the [Cosign
|
||||||
Bundle Specification][10].
|
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](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
|
> **NOTE**: When pushing to Docker Hub, please use "index.docker.io" as the
|
||||||
> registry portion of the image name.
|
> registry portion of the image name.
|
||||||
|
|
||||||
@ -310,6 +300,16 @@ jobs:
|
|||||||
push-to-registry: true
|
push-to-registry: true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Artifact Metadata Storage Records
|
||||||
|
|
||||||
|
If the `push-to-registry` option is set to true, the Action will also
|
||||||
|
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`.
|
||||||
|
|
||||||
### Integration with `actions/upload-artifact`
|
### Integration with `actions/upload-artifact`
|
||||||
|
|
||||||
If you'd like to create an attestation for an archive created with the
|
If you'd like to create an attestation for an archive created with the
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user