Skip to content

Commit

Permalink
docs: add release steps for a new major release (#378)
Browse files Browse the repository at this point in the history
Signed-off-by: Asra Ali <asraa@google.com>

Signed-off-by: Asra Ali <asraa@google.com>
Co-authored-by: laurentsimon <64505099+laurentsimon@users.noreply.github.com>
  • Loading branch information
asraa and laurentsimon authored Dec 2, 2022
1 parent d50e89b commit b6a9853
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Major and minor releases are released directly from the `main` branch. Patch ver

### New major or minor release

For a new major version update, ensure that the new version's go.mod file appends the new major version number to the module path. Then, update every imported package from the module with the new major version. See [here](https://go.dev/doc/modules/major-version) for details.

### 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).
Expand All @@ -32,7 +34,11 @@ This will trigger a release workflow: wait until it completes and generates the

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.
Check the following:

1. Ensure that the release is successful and provenance can be verified properly.
2. 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.
3. Ensure that the latest release can be installed via a `go install`.

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

Expand Down

0 comments on commit b6a9853

Please sign in to comment.