Skip to content

Commit 13ec7f0

Browse files
docs: update release process with Go dependency upgrade steps
- Add instructions for upgrading Go dependencies using go-mod-upgrade - Update govulncheck step to use make verify-govulncheck - Renumber and clarify release steps for improved readability Signed-off-by: Richard Wall <[email protected]>
1 parent e9b2515 commit 13ec7f0

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

RELEASE.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,54 @@ The release process is semi-automated.
1515
> - Create a draft GitHub release,
1616
> - Upload the Helm chart tarball to the GitHub release.
1717
18-
1. Open the [tests GitHub Actions workflow][tests-workflow]
18+
1. Upgrade the Go dependencies.
19+
20+
You will need to install `go-mod-upgrade`:
21+
22+
```bash
23+
go install github.com/oligot/go-mod-upgrade@latest
24+
```
25+
26+
Then, run the following:
27+
28+
```bash
29+
go-mod-upgrade
30+
make generate
31+
```
32+
33+
Finally, create a PR with the changes and merge it.
34+
35+
2. Open the [tests GitHub Actions workflow][tests-workflow]
1936
and verify that it succeeds on the master branch.
2037

21-
2. Run govulncheck:
38+
3. Run govulncheck:
2239
```bash
23-
go install golang.org/x/vuln/cmd/govulncheck@latest
24-
govulncheck -v ./...
40+
make verify-govulncheck
2541
```
2642

27-
3. Create a tag for the new release:
43+
4. Create a tag for the new release:
2844
```sh
2945
export VERSION=v1.1.0
3046
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
3147
git push origin "${VERSION}"
3248
```
3349

34-
4. Wait until the GitHub Actions finishes.
50+
5. Wait until the GitHub Actions finishes.
3551

36-
5. Navigate to the GitHub Releases page and select the draft release to edit.
52+
6. Navigate to the GitHub Releases page and select the draft release to edit.
3753
1. Click on “Generate release notes” to automatically compile the changelog.
3854
2. Review and refine the generated notes to ensure they’re clear and useful
3955
for end users.
4056
3. Remove any irrelevant entries, such as “update deps,” “update CI,” “update
4157
docs,” or similar internal changes that do not impact user functionality.
4258

43-
6. Publish the release.
59+
7. Publish the release.
4460

45-
7. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
61+
8. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
4662
released. Make sure to share any breaking change that may affect `venctl connect`
4763
or `venctl generate`.
4864

49-
8. Inform Michael McLoughlin of the new release so he can update the
65+
9. Inform Michael McLoughlin of the new release so he can update the
5066
documentation at <https://docs.venafi.cloud/>.
5167

5268
[tests-workflow]: https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml?query=branch%3Amaster

0 commit comments

Comments
 (0)