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.

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

Conversation

ramonpetgrave64
Copy link
Collaborator

@ramonpetgrave64 ramonpetgrave64 commented Apr 25, 2024

Summary

A few fixes and additions to the release docs.

  • fix the sed commands
  • add Github container registry auth instructions

related PR slsa-framework/slsa-verifier#761

Testing Process

Manual testing locally.

Checklist

  • Review the contributing guidelines
  • Add a reference to related issues in the PR description.
  • Update documentation if applicable.
  • Add unit tests if applicable.
  • Add changes to the CHANGELOG if applicable.

Signed-off-by: Ramon Petgrave <[email protected]>
Signed-off-by: Ramon Petgrave <[email protected]>
@ramonpetgrave64 ramonpetgrave64 marked this pull request as ready for review April 25, 2024 21:02
@ramonpetgrave64
Copy link
Collaborator Author

@mihaimaruseac

RELEASE.md Outdated Show resolved Hide resolved
Signed-off-by: Ramon Petgrave <[email protected]>
@ramonpetgrave64
Copy link
Collaborator Author

@joshuagl

Copy link
Contributor

@mihaimaruseac mihaimaruseac left a comment

Choose a reason for hiding this comment

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

I'm a little bit concerned that thesesed expressions are hard to maintain, but since they were here from before the PR, I think it should be ok

RELEASE.md Outdated Show resolved Hide resolved
Signed-off-by: Ramon Petgrave <[email protected]>
@ramonpetgrave64 ramonpetgrave64 enabled auto-merge (squash) May 2, 2024 20:16
@ramonpetgrave64
Copy link
Collaborator Author

@ianlewis

RELEASE.md Outdated Show resolved Hide resolved
RELEASE.md Show resolved Hide resolved
@@ -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

@ianlewis
Copy link
Member

ianlewis commented May 7, 2024

I'm a little bit concerned that thesesed expressions are hard to maintain, but since they were here from before the PR, I think it should be ok

I totally sympathize with this. I think the release process is entirely too manual but it's difficult to automate. Ideally we wouldn't need to do this but I think we need to iterate to improve as best we can.

ramonpetgrave64 and others added 2 commits May 7, 2024 12:13
Co-authored-by: Ian Lewis <[email protected]>
Signed-off-by: Ramon Petgrave <[email protected]>
Co-authored-by: Ian Lewis <[email protected]>
Signed-off-by: Ramon Petgrave <[email protected]>
@ramonpetgrave64 ramonpetgrave64 merged commit 2f113ff into slsa-framework:main May 8, 2024
74 checks passed
ramonpetgrave64 added a commit to slsa-framework/slsa-verifier that referenced this pull request Jun 27, 2024
Making the `download-artifacts.sh` script be more useful.

Before, it would error upon seeing some zip files that it doesn't expect
to be in the GH release. I think the script is just a bit outdated. But
for now, I think we should bypass that, since the script is already
written to know which of the final files within the archives are
actually needed.

related PR
slsa-framework/slsa-github-generator#3589

Signed-off-by: Ramon Petgrave <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants