mirror of
https://github.com/actions/attest-build-provenance.git
synced 2025-12-16 12:19:04 +00:00
bump actions/attest to v2.0.0 (#321)
Signed-off-by: Brian DeHamer <bdehamer@github.com>
This commit is contained in:
parent
90d4930a58
commit
619dbb2e03
23
README.md
23
README.md
@ -62,7 +62,7 @@ See [action.yml](action.yml)
|
|||||||
with:
|
with:
|
||||||
# Path to the artifact serving as the subject of the attestation. Must
|
# Path to the artifact serving as the subject of the attestation. Must
|
||||||
# specify exactly one of "subject-path" or "subject-digest". May contain a
|
# specify exactly one of "subject-path" or "subject-digest". May contain a
|
||||||
# glob pattern or list of paths (total subject count cannot exceed 2500).
|
# glob pattern or list of paths (total subject count cannot exceed 1024).
|
||||||
subject-path:
|
subject-path:
|
||||||
|
|
||||||
# SHA256 digest of the subject for the attestation. Must be in the form
|
# SHA256 digest of the subject for the attestation. Must be in the form
|
||||||
@ -93,26 +93,22 @@ See [action.yml](action.yml)
|
|||||||
|
|
||||||
<!-- markdownlint-disable MD013 -->
|
<!-- markdownlint-disable MD013 -->
|
||||||
|
|
||||||
| Name | Description | Example |
|
| Name | Description | Example |
|
||||||
| ------------- | -------------------------------------------------------------- | ------------------------ |
|
| ------------- | -------------------------------------------------------------- | ----------------------- |
|
||||||
| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.jsonl` |
|
| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.json` |
|
||||||
|
|
||||||
<!-- markdownlint-enable MD013 -->
|
<!-- markdownlint-enable MD013 -->
|
||||||
|
|
||||||
Attestations are saved in the JSON-serialized [Sigstore bundle][6] format.
|
Attestations are saved in the JSON-serialized [Sigstore bundle][6] format.
|
||||||
|
|
||||||
If multiple subjects are being attested at the same time, each attestation will
|
If multiple subjects are being attested at the same time, a single attestation
|
||||||
be written to the output file on a separate line (using the [JSON Lines][7]
|
will be created with references to each of the supplied subjects.
|
||||||
format).
|
|
||||||
|
|
||||||
## Attestation Limits
|
## Attestation Limits
|
||||||
|
|
||||||
### Subject Limits
|
### Subject Limits
|
||||||
|
|
||||||
No more than 2500 subjects can be attested at the same time. Subjects will be
|
No more than 1024 subjects can be attested at the same time.
|
||||||
processed in batches 50. After the initial group of 50, each subsequent batch
|
|
||||||
will incur an exponentially increasing amount of delay (capped at 1 minute of
|
|
||||||
delay per batch) to avoid overwhelming the attestation API.
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@ -148,8 +144,8 @@ jobs:
|
|||||||
|
|
||||||
### Identify Multiple Subjects
|
### Identify Multiple Subjects
|
||||||
|
|
||||||
If you are generating multiple artifacts, you can generate a provenance
|
If you are generating multiple artifacts, you can attest all of them at the same
|
||||||
attestation for each by using a wildcard in the `subject-path` input.
|
time by using a wildcard in the `subject-path` input.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-build-provenance@v1
|
- uses: actions/attest-build-provenance@v1
|
||||||
@ -245,7 +241,6 @@ jobs:
|
|||||||
[5]: https://cli.github.com/manual/gh_attestation_verify
|
[5]: https://cli.github.com/manual/gh_attestation_verify
|
||||||
[6]:
|
[6]:
|
||||||
https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto
|
https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto
|
||||||
[7]: https://jsonlines.org/
|
|
||||||
[8]: https://github.com/actions/toolkit/tree/main/packages/glob#patterns
|
[8]: https://github.com/actions/toolkit/tree/main/packages/glob#patterns
|
||||||
[9]:
|
[9]:
|
||||||
https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
|
https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
|
||||||
|
|||||||
@ -10,7 +10,7 @@ inputs:
|
|||||||
description: >
|
description: >
|
||||||
Path to the artifact serving as the subject of the attestation. Must
|
Path to the artifact serving as the subject of the attestation. Must
|
||||||
specify exactly one of "subject-path" or "subject-digest". May contain a
|
specify exactly one of "subject-path" or "subject-digest". May contain a
|
||||||
glob pattern or list of paths (total subject count cannot exceed 2500).
|
glob pattern or list of paths (total subject count cannot exceed 1024).
|
||||||
required: false
|
required: false
|
||||||
subject-digest:
|
subject-digest:
|
||||||
description: >
|
description: >
|
||||||
@ -44,7 +44,7 @@ inputs:
|
|||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
bundle-path:
|
bundle-path:
|
||||||
description: 'The path to the file containing the attestation bundle(s).'
|
description: 'The path to the file containing the attestation bundle.'
|
||||||
value: ${{ steps.attest.outputs.bundle-path }}
|
value: ${{ steps.attest.outputs.bundle-path }}
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
@ -52,7 +52,7 @@ runs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/attest-build-provenance/predicate@36fa7d009e22618ca7cd599486979b8150596c74 # predicate@1.1.4
|
- uses: actions/attest-build-provenance/predicate@36fa7d009e22618ca7cd599486979b8150596c74 # predicate@1.1.4
|
||||||
id: generate-build-provenance-predicate
|
id: generate-build-provenance-predicate
|
||||||
- uses: actions/attest@67422f5511b7ff725f4dbd6fb9bd2cd925c65a8d # v1.4.1
|
- uses: actions/attest@v2.0.0
|
||||||
id: attest
|
id: attest
|
||||||
with:
|
with:
|
||||||
subject-path: ${{ inputs.subject-path }}
|
subject-path: ${{ inputs.subject-path }}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user