Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update release docs #3589

Merged
merged 10 commits into from
May 8, 2024
Merged

fix: Update release docs #3589

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f4d720e
push upstream
ramonpetgrave64 Apr 25, 2024
4c705cf
fix sed command
ramonpetgrave64 Apr 25, 2024
0a8d40d
add github container auth instructions
ramonpetgrave64 Apr 25, 2024
3936e6c
Merge branch 'main' into update-release-docs
ramonpetgrave64 Apr 25, 2024
af41c0a
change upstream to origin
ramonpetgrave64 Apr 29, 2024
816e09e
use $GITHUB_USERNAME
ramonpetgrave64 May 2, 2024
a3123c4
Merge branch 'main' into update-release-docs
ramonpetgrave64 May 6, 2024
4067dca
say export the image
ramonpetgrave64 May 7, 2024
7c111c8
Update RELEASE.md
ramonpetgrave64 May 7, 2024
891c6da
Merge branch 'main' into update-release-docs
ramonpetgrave64 May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Once the PR is merged, immediately update the tag to point to HEAD.

```shell
git tag $BUILDER_TAG -f
git push origin $BUILDER_TAG -f
git push upstream $BUILDER_TAG -f
ramonpetgrave64 marked this conversation as resolved.
Show resolved Hide resolved
```

This will trigger the [release workflow](https://github.com/slsa-framework/slsa-github-generator/actions/workflows/release.yml). Ensure this workflow succeeds and that the release assets are updated.
Expand Down Expand Up @@ -163,7 +163,7 @@ There is one integration test we cannot easily test "live", so we need to simula
using this command:

```shell
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\\\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/builder_go_slsa3.yml
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/builder_go_slsa3.yml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were these commands not working for some reason?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not on my machine

```

Add `testing: true` as an input.
Expand All @@ -177,7 +177,7 @@ There is one integration test we cannot easily test "live", so we need to simula
using this command:

```shell
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\\\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/generator_generic_slsa3.yml
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/generator_generic_slsa3.yml
```

Add `testing: true` as an input.
Expand All @@ -191,7 +191,7 @@ There is one integration test we cannot easily test "live", so we need to simula
using this command:

```shell
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\\\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/generator_container_slsa3.yml
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/generator_container_slsa3.yml
```

Add `testing: true` as an input.
Expand All @@ -205,7 +205,7 @@ There is one integration test we cannot easily test "live", so we need to simula
using this command:

```shell
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\\\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/builder_container-based_slsa3.yml
sed -i "s/uses: slsa-framework\/slsa-github-generator\/\.github\/actions\/generate-builder@\(main\|v[0-9]\+\.[0-9]\+\.[0-9]\+\(-rc\.[0-9]\+\)\?\)/uses: ${BUILDER_REPOSITORY/\//\/}\/.github\/actions\/generate-builder@${BUILDER_TAG}/" .github/workflows/builder_container-based_slsa3.yml
```

Add `testing: true` as an input.
Expand Down Expand Up @@ -535,7 +535,7 @@ Once the PR is merged, immediately update the tag to point to HEAD.

```shell
git tag $BUILDER_TAG -f
git push origin $BUILDER_TAG -f
git push upstream $BUILDER_TAG -f
```

This will trigger the [release workflow](https://github.com/slsa-framework/slsa-github-generator/actions/workflows/release.yml). Ensure this workflow succeeds and that the release assets are updated.
Expand Down Expand Up @@ -618,6 +618,13 @@ Then, for each of the GHA builders, you will need to:
`./cli/slsa-verifier/testdata/gha_generic_container/$BUILDER_TAG/` directory
in the slsa-verifier repository.

login to Github's container registry
ramonpetgrave64 marked this conversation as resolved.
Show resolved Hide resolved

```shell
gh auth login --scopes=read:packages
echo `gh auth token` | docker login ghcr.io -u ramonpetgrave64 --password-stdin
ramonpetgrave64 marked this conversation as resolved.
Show resolved Hide resolved
```

ramonpetgrave64 marked this conversation as resolved.
Show resolved Hide resolved
```shell
cosign save \
--dir ./cli/slsa-verifier/testdata/gha_generic_container/$BUILDER_TAG/container_workflow_dispatch \
Expand Down
Loading