-
Notifications
You must be signed in to change notification settings - Fork 49
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
Ensure that README.md documentation states the latest release #370
Comments
We have a pull request outstanding on slsa-github-generator for this. The same thing could be applied here. /cc @pnacht |
I've taken a gander at the code and this shouldn't be too complex. However, I believe I'll only be able to look at it early 23Q1. |
I've written a bash script similar in spirit to slsa-github-generator's references.sh, but fit for purpose in this repo. It checks that SHA256SUM.md and README.md always refer to the same slsa-verifier version, and that this version matches the major version declared in go.mod. The README.md check is a bit fragile. It only detects version numbers that come after the string I now want to add this script to a workflow. Similar to slsa-github-generator (after slsa-framework/slsa-github-generator#1266), my idea would be to add a pre-release check to the release.yml workflow. However, looking at RELEASE.md, I have a few questions:
|
I think updating the docs prior to the release should be ok. Though I don't see that we create a PR before creating the release candidate so you couldn't do it in a pre-submit unless you did checked the PR description for a
I think it can be run manually and the RELEASE.md has instructions for that. Since the references need to exist before you can update and run the workflow, I think those instructions are ok where there are. We should catch most issues with the RC releases. |
Ah yes, you're right. |
See #369
to ensure that the documentation is up-to-date with the latest release in SHA256SUM.md and the latest GitHub releases
The text was updated successfully, but these errors were encountered: