Skip to content

Commit e544700

Browse files
authored
readme: add govulncheck and checking github action to release process
1 parent 2b956c8 commit e544700

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,26 +102,35 @@ The release process is semi-automated.
102102
> - Create a draft GitHub release,
103103
> - Upload the Helm chart tarball to the GitHub release.
104104
105-
1. Create a tag for the new release:
105+
1. Open the [tests GitHub Actions workflow][tests-workflow]
106+
and verify that it succeeds on the master branch.
107+
2. Run govulncheck:
108+
```bash
109+
go install golang.org/x/vuln/cmd/govulncheck@latest
110+
govulncheck -v ./...
111+
```
112+
3. Create a tag for the new release:
106113
```sh
107114
export VERSION=v1.1.0
108115
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
109116
git push origin "${VERSION}"
110117
```
111-
2. Wait until the GitHub Actions finishes.
112-
3. Navigate to the GitHub Releases page and select the draft release to edit.
118+
4. Wait until the GitHub Actions finishes.
119+
5. Navigate to the GitHub Releases page and select the draft release to edit.
113120
1. Click on “Generate release notes” to automatically compile the changelog.
114121
2. Review and refine the generated notes to ensure they’re clear and useful
115122
for end users.
116123
3. Remove any irrelevant entries, such as “update deps,” “update CI,” “update
117124
docs,” or similar internal changes that do not impact user functionality.
118-
4. Publish the release.
119-
5. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
125+
6. Publish the release.
126+
7. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
120127
released. Make sure to share any breaking change that may affect `venctl connect`
121128
or `venctl generate`.
122-
7. Inform Michael McLoughlin of the new release so he can update the
129+
8. Inform Michael McLoughlin of the new release so he can update the
123130
documentation at <https://docs.venafi.cloud/>.
124131

132+
[tests-workflow]: https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml?query=branch%3Amaster
133+
125134
> [!NOTE]
126135
>
127136
> For context, the new tag will create the following images:

0 commit comments

Comments
 (0)