Skip to content

Commit 799a179

Browse files
authored
add link to cosign bundle spec to readme (#63)
Signed-off-by: Brian DeHamer <bdehamer@github.com>
1 parent 317e606 commit 799a179

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ initiated.
1919
Attestations can be verified using the [`attestation` command in the GitHub
2020
CLI][5].
2121

22-
See [Using artifact attestations to establish provenance for builds][9]
23-
for more information on artifact attestations.
22+
See [Using artifact attestations to establish provenance for builds][9] for more
23+
information on artifact attestations.
2424

2525
## Usage
2626

@@ -36,8 +36,8 @@ attest:
3636
```
3737
3838
The `id-token` permission gives the action the ability to mint the OIDC token
39-
permission is necessary to persist the attestation. The `attestations` permission
40-
is necessary to persist the attestation.
39+
permission is necessary to persist the attestation. The `attestations`
40+
permission is necessary to persist the attestation.
4141

4242
1. Add the following to your workflow after your artifact has been built:
4343

@@ -154,6 +154,9 @@ fully-qualified image name (e.g. "ghcr.io/user/app" or
154154
"acme.azurecr.io/user/app"). Do NOT include a tag as part of the image name --
155155
the specific image being attested is identified by the supplied digest.
156156

157+
Attestation bundles are stored in the OCI registry according to the [Cosign
158+
Bundle Specification][10].
159+
157160
> **NOTE**: When pushing to Docker Hub, please use "index.docker.io" as the
158161
> registry portion of the image name.
159162

@@ -210,4 +213,6 @@ jobs:
210213
https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto
211214
[7]: https://jsonlines.org/
212215
[8]: https://github.com/actions/toolkit/tree/main/packages/glob#patterns
213-
[9]: https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
216+
[9]:
217+
https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
218+
[10]: https://github.com/sigstore/cosign/blob/main/specs/BUNDLE_SPEC.md

0 commit comments

Comments
 (0)