Merge pull request #121 from philips-labs/improvements

Improvements
philips-labs · Jan 14, 2022 · 5f93fbd · 5f93fbd
2 parents 58d245d + 43d7a70
commit 5f93fbd
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/.goreleaser.draft.yml b/.goreleaser.draft.yml
@@ -128,3 +128,8 @@ release:
   prerelease: auto
   extra_files:
     - glob: "./cosign.pub"
+  footer: |
+    {{- if .repository }}
+    **Full Changelog**: {{ .repository }}/compare/{{ .PreviousTag }}...{{ .Tag }}
+    {{- end }}
+    ---
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -128,3 +128,8 @@ release:
   prerelease: auto
   extra_files:
     - glob: "./cosign.pub"
+  footer: |
+    {{- if .repository }}
+    **Full Changelog**: {{ .repository }}/compare/{{ .PreviousTag }}...{{ .Tag }}
+    {{- end }}
+    ---
diff --git a/release.md → RELEASE.md b/release.md → RELEASE.md
@@ -5,7 +5,7 @@
 To make a new release you can make use of the following `make` task.
 
 ```bash
-make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.1-draft DESCRIPTION="A test release to see how it works"
+make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.0 DESCRIPTION="A test release to see how it works"
 ```
 
 `NEW_VERSION` the version that you want to release.
@@ -15,6 +15,8 @@ make gh-release NEW_VERSION=v0.6.0 OLD_VERSION=v0.5.1-draft DESCRIPTION="A test
 Visit <https://github.com/philips-labs/slsa-provenance-action/releases>.
 Edit the release and save it to publish to GitHub Marketplace.
 
+> :warning: **NOTE:** when you need to test some changes in `.goreleaser.yml`, also apply the changes to `.goreleaser.draft.yml`. Then make sure your new `tag` ends with `-draft` (e.g.: `v0.7.0-draft`) to make a draft release to not notify our consumers when testing updates to the release process.
+
 ### ⚠ Important alert for MacOS users ⚠
 
 On MacOS `sed` has different behaviour and therefore doesn't work out of the box.

diff --git a/lib/github/releases_test.go b/lib/github/releases_test.go
@@ -195,7 +195,7 @@ func TestListReleases(t *testing.T) {
 	api := "https://api.github.com/repos/philips-labs/slsa-provenance-action/releases"
 
 	client, requestLogger := createReleaseClient(ctx)
-	opt := gh.ListOptions{PerPage: 4}
+	opt := gh.ListOptions{PerPage: 5}
 	releases, err := client.ListReleases(ctx, owner, repo, opt)
 	if !assert.NoError(err) {
 		return