Skip to content

Commit

Permalink
docs: update release.md docs to describe a pre-release (slsa-framewor…
Browse files Browse the repository at this point in the history
…k#314)

* update docs

Signed-off-by: Asra Ali <asraa@google.com>
  • Loading branch information
asraa authored Oct 21, 2022
1 parent c151f47 commit efc53fc
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion RELEASE.md
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.

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

0 comments on commit efc53fc

Please sign in to comment.