Skip to content

Commit b6a9853

Browse files
asraalaurentsimon
andauthored
docs: add release steps for a new major release (#378)
Signed-off-by: Asra Ali <[email protected]> Signed-off-by: Asra Ali <[email protected]> Co-authored-by: laurentsimon <[email protected]>
1 parent d50e89b commit b6a9853

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

RELEASE.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Major and minor releases are released directly from the `main` branch. Patch ver
1818

1919
### New major or minor release
2020

21+
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.
22+
2123
### Dry-Run
2224

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

3335
Do **NOT** submit any more code between now and the final release.
3436

35-
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.
37+
Check the following:
38+
39+
1. Ensure that the release is successful and provenance can be verified properly.
40+
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.
41+
3. Ensure that the latest release can be installed via a `go install`.
3642

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

0 commit comments

Comments
 (0)