Skip to content

Commit 9093407

Browse files
Document that actions/download-artifact@v3 must be used to download provenance (#3067)
Fixes #3066 --------- Signed-off-by: Jürgen Kreileder <[email protected]> Co-authored-by: laurentsimon <[email protected]>
1 parent 71334cc commit 9093407

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

internal/builders/docker/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ type that provides the full details on the build process.
4242
- [The `build` subcommand](#the-build-subcommand)
4343
- [The `verify` command](#the-verify-command)
4444
- [Users](#users)
45+
- [Known Issues](#known-issues)
46+
- [Compatibility with `actions/download-artifact`](#compatibility-with-actionsdownload-artifact)
4547

4648
<!-- tocstop -->
4749

@@ -403,3 +405,14 @@ The following project currently use the container-based workflow:
403405

404406
We welcome any success stories. Please create a PR to add your project to the
405407
list, if you are using the container-based workflow.
408+
409+
## Known Issues
410+
411+
### Compatibility with `actions/download-artifact`
412+
413+
To download provenance (e.g., if you don't use `upload-assets`) you have to
414+
use [`actions/download-artifact@v3`](https://github.com/actions/download-artifact).
415+
The workflow uses [`actions/upload-artifact@3`](https://github.com/actions/upload-artifact)
416+
which is
417+
[not compatible](https://github.com/actions/download-artifact?tab=readme-ov-file#breaking-changes)
418+
with `actions/download-artifact@v4`.

internal/builders/generic/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ project simply generates provenance as a separate step in an existing workflow.
4646
- [Skip output 'hashes' since it may contain secret](#skip-output-hashes-since-it-may-contain-secret)
4747
- ['internal error' when using `upload-assets`](#internal-error-when-using-upload-assets)
4848
- [error updating to TUF remote mirror: tuf: invalid key](#error-updating-to-tuf-remote-mirror-tuf-invalid-key)
49+
- [Compatibility with `actions/download-artifact`](#compatibility-with-actionsdownload-artifact)
4950

5051
<!-- tocstop -->
5152

@@ -1467,3 +1468,12 @@ using a release tag in order to allow verification by `slsa-verifier`.
14671468
```yaml
14681469
uses: slsa-framework/slsa-github-generator/.github/workflows/[email protected]
14691470
```
1471+
1472+
### Compatibility with `actions/download-artifact`
1473+
1474+
To download provenance (e.g., if you don't use `upload-assets`) you have to
1475+
use [`actions/download-artifact@v3`](https://github.com/actions/download-artifact).
1476+
The workflow uses [`actions/upload-artifact@3`](https://github.com/actions/upload-artifact)
1477+
which is
1478+
[not compatible](https://github.com/actions/download-artifact?tab=readme-ov-file#breaking-changes)
1479+
with `actions/download-artifact@v4`.

internal/builders/go/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ This document explains how to use the builder for [Go](https://go.dev/) projects
2222
- [BuildConfig Format](#buildconfig-format)
2323
- [Known Issues](#known-issues)
2424
- [error updating to TUF remote mirror: tuf: invalid key](#error-updating-to-tuf-remote-mirror-tuf-invalid-key)
25+
- [Compatibility with `actions/download-artifact`](#compatibility-with-actionsdownload-artifact)
2526

2627
<!-- tocstop -->
2728

@@ -421,3 +422,12 @@ release tag in order to allow verification by `slsa-verifier`.
421422
```yaml
422423
uses: slsa-framework/slsa-github-generator/.github/workflows/[email protected]
423424
```
425+
426+
### Compatibility with `actions/download-artifact`
427+
428+
To download provenance (e.g., if you don't use `upload-assets`) you have to
429+
use [`actions/download-artifact@v3`](https://github.com/actions/download-artifact).
430+
The workflow uses [`actions/upload-artifact@3`](https://github.com/actions/upload-artifact)
431+
which is
432+
[not compatible](https://github.com/actions/download-artifact?tab=readme-ov-file#breaking-changes)
433+
with `actions/download-artifact@v4`.

0 commit comments

Comments
 (0)