Skip to content

Commit e0ef4b0

Browse files
authored
release: add notes for release v1.2.0 (slsa-framework#171)
Signed-off-by: Asra Ali <[email protected]>
1 parent 4ee9667 commit e0ef4b0

File tree

3 files changed

+32
-6
lines changed

3 files changed

+32
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ You have two options to install the verifier.
2323

2424
#### Option 1: Install via go
2525
```
26-
$ go install github.com/slsa-framework/slsa-verifier@v1.1.1
26+
$ go install github.com/slsa-framework/slsa-verifier@v1.2.0
2727
$ slsa-verifier <options>
2828
```
2929

3030
#### Option 2: Compile manually
3131
```
3232
$ git clone [email protected]:slsa-framework/slsa-verifier.git
33-
$ cd slsa-verifier && git checkout v1.1.1
33+
$ cd slsa-verifier && git checkout v1.2.0
3434
$ go run . <options>
3535
```
3636

3737
### Download the binary
3838

39-
Download the binary from the latest release at [https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.1.1](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.1.1)
39+
Download the binary from the latest release at [https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.2.0](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.2.0)
4040

4141
Download the [SHA256SUM.md](https://github.com/slsa-framework/slsa-verifier/blob/main/SHA256SUM.md).
4242

@@ -76,9 +76,9 @@ $ go run . --help
7676
### Example
7777

7878
```bash
79-
$ go run . -artifact-path ~/Downloads/slsa-verifier-linux-amd64 -provenance ~/Downloads/slsa-verifier-linux-amd64.intoto.jsonl -source github.com/slsa-framework/slsa-verifier -tag v1.1.1
80-
Verified signature against tlog entry index 2727751 at URL: https://rekor.sigstore.dev/api/v1/log/entries/8f3d898ef17d9c4c028fe3da09fb786c900bf786361e75432f325b4848fdba24
81-
Verified build using builder https://github.com/slsa-framework/slsa-github-generator/.github/workflows/builder_go_slsa3.yml@refs/tags/v1.1.0 at commit 76a59d8413f27259b97298da91bbb6511fc775d1
79+
$ go run . -artifact-path ~/Downloads/slsa-verifier-linux-amd64 -provenance ~/Downloads/slsa-verifier-linux-amd64.intoto.jsonl -source github.com/slsa-framework/slsa-verifier -tag v1.2.0
80+
Verified signature against tlog entry index 3027785 at URL: https://rekor.sigstore.dev/api/v1/log/entries/0cdff5b6a013379f9c1c5c6c598ad73c60de5acd969ba70ea2e874098b6e789f
81+
Verified build using builder https://github.com/slsa-framework/slsa-github-generator/.github/workflows/builder_go_slsa3.yml@refs/tags/v1.1.1 at commit fb9aeaf6384fd588e56ad90978fe025b3fd44849
8282
PASSED: Verified SLSA provenance
8383
```
8484

RELEASE.md

+20
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ This is a document to describe the release process for the verifier.
1414

1515
## Publish release
1616

17+
Major and minor releases are released directly from the `main` branch. Patch versions are released from the `release/vX.Y` branch.
18+
19+
### New major or minor release
20+
1721
Create a new tag for the official generator via [slsa-framework/slsa-verifier/releases/new](https://github.com/slsa-framework/slsa-verifier/releases/new).
1822

1923
Use a "canonical" semantic version without metadata `vX.Y.Z`.
@@ -24,6 +28,20 @@ Click `Publish release`.
2428

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

31+
From the repository landing page, use the branch drop-down to create a branch from the tagged release with the format `release/vX.Y`. This will be used for backporting critical fixes and releases patch versions.
32+
33+
### New patch release
34+
35+
Critical patch fixes are released from the `release/vX.Y` branch. Once the backported fix has been merged, create a new tag for the official generator via [slsa-framework/slsa-verifier/releases/new](https://github.com/slsa-framework/slsa-verifier/releases/new). Use the `release/vX.Y` branch as the Target.
36+
37+
Use a "canonical" semantic version without metadata `vX.Y.Z`.
38+
39+
Set the title to `vX.Y.Z`.
40+
41+
Click `Publish release`.
42+
43+
This will trigger a release workflow: wait until it completes and generates the binary and the provenance.
44+
2745
## Verify provenance
2846

2947
Follow the steps:
@@ -38,6 +56,8 @@ $ cd slsa-verifier
3856
$ go run . -artifact-path slsa-verifier-linux-amd64 -provenance slsa-verifier-linux-amd64.intoto.jsonl -source github.com/slsa-framework/slsa-verifier -tag vX.Y.Z
3957
```
4058

59+
You should include the `-branch release/vX.Y` for patch version releases.
60+
4161
If the provenance verification fails, delete the release and the tag. Otherwise, continue.
4262

4363
## Update documentation

SHA256SUM.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1+
### [v1.2.0](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.2.0)
2+
37db23392c7918bb4e243cdb097ed5f9d14b9b965dc1905b25bc2d1c0c91bf3d slsa-verifier-linux-amd64
3+
14
### [v1.1.1](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.1.1)
25
f92fc4e571949c796d7709bb3f0814a733124b0155e484fad095b5ca68b4cb21 slsa-verifier-linux-amd64
36

47
### [v1.1.0](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.1.0)
58
14360688de2d294e9cda7b9074ab7dcf02d5c38f2874f6c95d4ad46e300c3e53 slsa-verifier-linux-amd64
69

10+
### [v1.0.2](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.0.2)
11+
bcefa5173ad84fbb10d3aeae95c1087f6a61e51836b932c60be85c78d570c403 slsa-verifier-linux-amd64
12+
713
### [v1.0.1](https://github.com/slsa-framework/slsa-verifier/releases/tag/v1.0.1)
814
e14616a4eec58f082fd6bea05de02dd9eba193379ddb15b5eb7e7e3880d0ccec slsa-verifier-linux-amd64
915

0 commit comments

Comments
 (0)