Skip to content

Commit 2512315

Browse files
ramonpetgrave64ramonpetgrave64
authored
feat(breaking): remove attestation-name input and output (#3456)
# Summary - Reverting #3399 - Fixes #3031 - Fixes #3072 - Removes the attestation-name input and output from the generator_generic_slsa3.yml, which has been deprecated for provenance-name. ## Testing Process - We have existing PR Check workflows that do call the generic-genertor wth the correct parameters - example-package e2e2 tests have already been updated to use the new parameter and are already passing. ## Checklist - [x] Review the contributing [guidelines](./../CONTRIBUTING.md) - [x] Add a reference to related issues in the PR description. - [x] Update documentation if applicable. - [x] Add unit tests if applicable. - [x] Add changes to the [CHANGELOG](./../CHANGELOG.md) if applicable. Signed-off-by: Ramon Petgrave <[email protected]>
1 parent 4fbc6a9 commit 2512315

File tree

3 files changed

+5
-15
lines changed

3 files changed

+5
-15
lines changed

‎.github/workflows/generator_generic_slsa3.yml

-13
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,6 @@ on:
5656
the assets.
5757
type: string
5858
default: ""
59-
attestation-name:
60-
description: "The artifact name of the signed provenance. The file must have the intoto.jsonl extension. Defaults to <filename>.intoto.jsonl for single artifact or multiple.intoto.jsonl for multiple artifacts. DEPRECATED: Use provenance-name instead."
61-
required: false
62-
type: string
6359
provenance-name:
6460
description: The artifact name of the signed provenance. The file must have the intoto.jsonl extension. Defaults to <filename>.intoto.jsonl for single artifact or multiple.intoto.jsonl for multiple artifacts.
6561
required: false
@@ -98,9 +94,6 @@ on:
9894
Note: This value is non-empty only when a release asset is uploaded, according to
9995
the values of `upload-assets` and `upload-tag-name`.
10096
value: ${{ jobs.upload-assets.outputs.release-id }}
101-
attestation-name:
102-
description: "DEPRECATED: use the provenance-name output instead."
103-
value: ${{ jobs.generator.outputs.provenance-name }}
10497
provenance-name:
10598
description: "The artifact name of the signed provenance. (A file with the intoto.jsonl extension)."
10699
value: ${{ jobs.generator.outputs.provenance-name }}
@@ -226,17 +219,11 @@ jobs:
226219
env:
227220
GITHUB_CONTEXT: "${{ toJSON(github) }}"
228221
UNTRUSTED_PROVENANCE_NAME: "${{ inputs.provenance-name }}"
229-
UNTRUSTED_DEPRECATED_ATTESTATION_NAME: "${{ inputs.attestation-name }}"
230222
run: |
231223
set -euo pipefail
232224
untrusted_prov_name=""
233225
if [ "$UNTRUSTED_PROVENANCE_NAME" != "" ]; then
234226
untrusted_prov_name="$UNTRUSTED_PROVENANCE_NAME"
235-
else
236-
if [ "$UNTRUSTED_DEPRECATED_ATTESTATION_NAME" != "" ]; then
237-
echo "WARNING: deprecated attestation-name was used. Use provenance-name instead."
238-
untrusted_prov_name="$UNTRUSTED_DEPRECATED_ATTESTATION_NAME"
239-
fi
240227
fi
241228
# Create and sign provenance.
242229
# NOTE: The builder verifies that the provenance path is located

‎CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
<!-- toc -->
1111

1212
- [Unreleased](#unreleased)
13+
- [Unreleased: Breaking Change: attestation-name Workflow Input and Output](#unreleased-breaking-change-attestation-name-workflow-input-and-output)
1314
- [Unreleased: DSSE Rekor Type](#unreleased-dsse-rekor-type)
1415
- [v1.10.0](#v1100)
1516
- [v1.10.0: TUF fix](#v1100-tuf-fix)
@@ -102,6 +103,10 @@ duplication."
102103

103104
## Unreleased
104105

106+
### Unreleased: Breaking Change: attestation-name Workflow Input and Output
107+
108+
- `attestation-name` as a workflow input to `.github/workflows/generator_generic_slsa3.yml` is now removed. Use `provenance-name` instead.
109+
105110
### Unreleased: DSSE Rekor Type
106111

107112
- When uploading signed provenance to the log, the entry created in the log is now

‎internal/builders/generic/README.md

-2
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,6 @@ The [generic workflow](https://github.com/slsa-framework/slsa-github-generator/b
266266
| `upload-assets` | no | false | If true provenance is uploaded to a GitHub release for new tags. |
267267
| `upload-tag-name` | no | | If specified and `upload-assets` is set to true, the provenance will be uploaded to a Github release identified by the tag-name regardless of the triggering event. |
268268
| `provenance-name` | no | "(subject name).intoto.jsonl" if a single subject. "multiple.intoto.json" if multiple subjects. | The artifact name of the signed provenance. The file must have the `intoto.jsonl` extension. |
269-
| `attestation-name` | no | "(subject name).intoto.jsonl" if a single subject. "multiple.intoto.json" if multiple subjects. | The artifact name of the signed provenance. The file must have the `intoto.jsonl` extension. DEPRECATED: use `provenance-name` instead. |
270269
| `private-repository` | no | false | Set to true to opt-in to posting to the public transparency log. Will generate an error if false for private repositories. This input has no effect for public repositories. See [Private Repositories](#private-repositories). |
271270
| `continue-on-error` | no | false | Set to true to ignore errors. This option is useful if you won't want a failure to fail your entire workflow. |
272271
| `draft-release` | no | false | If true, the release is created as a draft |
@@ -278,7 +277,6 @@ The [generic workflow](https://github.com/slsa-framework/slsa-github-generator/b
278277
| Name | Description |
279278
| ------------------ | ----------------------------------------------------------------------------------------------- |
280279
| `provenance-name` | The artifact name of the signed provenance. |
281-
| `attestation-name` | The artifact name of the signed provenance. DEPRECATED: use `provenance-name` instead. |
282280
| `outcome` | If `continue-on-error` is `true`, will contain the outcome of the run (`success` or `failure`). |
283281

284282
### Provenance Format

0 commit comments

Comments
 (0)