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

docs: update release.md docs to describe a pre-release #314

Merged
merged 2 commits into from
Oct 21, 2022
Merged

docs: update release.md docs to describe a pre-release #314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a10c49
update docs
asraa Oct 21, 2022
b527440
update
asraa Oct 21, 2022
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
20 changes: 19 additions & 1 deletion RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,25 @@ Major and minor releases are released directly from the `main` branch. Patch ver

### New major or minor release

Create a new tag for the official generator via [slsa-framework/slsa-verifier/releases/new](https://github.com/slsa-framework/slsa-verifier/releases/new).
### Dry-Run

Create a release candidate for the official slsa-verifier via [slsa-framework/slsa-verifier/releases/new](https://github.com/slsa-framework/slsa-verifier/releases/new).

Use a pre-release name denoted with a hypen `vX.Y.Z-rc` (do not use a pre-release check, the e2e tests will ignore these). By creating a pre-release version, the release flow and e2e tests can be validated committing to the final version. Because Go module downloads are deterministic through the public GOPROXY, this helps ensure that the final released Go module is immutable: a final release version should not be deleted.

Set the title to `vX.Y.Z-rc`.

Click `Publish release`.

This will trigger a release workflow: wait until it completes and generates the binary and the provenance.

Do **NOT** submit any more code between now and the final release.
asraa marked this conversation as resolved.
Show resolved Hide resolved

Ensure that the release is successful and provenance can be verified properly. Then, either manually trigger or wait for a nightly scheduled run of all [example-package e2e tests](https://github.com/slsa-framework/example-package/tree/main/.github/workflows) and ensure that all tests are passing.

If both of these steps succeed, then move on to the [Final Release](#final-release).

### Final Release

Use a "canonical" semantic version without metadata `vX.Y.Z`.

Expand Down