-
Notifications
You must be signed in to change notification settings - Fork 60
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
chore: Add install tutorial with cosign check #506
Conversation
✅ Deploy Preview for witness-project ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
IMO, this should be the way we install using our install-witness.sh 😄 Of course, giving users details on installing it without the script is always good for clarity. A lot of folks don't like executing scripts blindly (even more folks from security 🤣 ) |
78dabf3
to
c8895d6
Compare
With #508 merged, we can test after the next release is cut and merge the docs. 🎉 |
Personally, I think it might be better to get rid of this script. In the script, we can't assume people have cosign installed (the right way) either, so overall it's quite complicated to get it right. I think perhaps pointing to brew.sh etc might be more appropriate alongside the downloading pre-built binary + sig check steps added in this PR. Maybe we also get it listed on winget? cc @patzielinski who oversaw that for gittuf recently. |
This looks to be a self-contained binary, so getting Witness onto Winget should be trivial. Note that version update pull requests need to be manually submitted to the Winget repo unlike Homebrew (unless a workflow is added to CI to automatically open PRs upon release - this requires a PAT to my knowledge) See the manifests for gittuf here: https://github.com/microsoft/winget-pkgs/tree/master/manifests/g/gittuf/gittuf/0.6.2 |
c8895d6
to
c26b894
Compare
Signed-off-by: Matthias Glastra <[email protected]>
Signed-off-by: John Kjell <[email protected]>
0cbfeac
to
1ce4556
Compare
we can |
Signed-off-by: John Kjell <[email protected]>
What this PR does / why we need it
Add install tutorial with cosign check. This allows people to install and verify the witness release. The additional pem output is needed to allow
cosign verify-blob
to work.The information that is in there is inspired by gittuf documentation that had it in there already. Thanks @adityasaky.
Which issue(s) this PR fixes (optional)
Fixes
Acceptance Criteria Met
Special notes for your reviewer:
It could be an option to move the INSTALL.md to the docs folder and make it part of the website too. Open for feedback.