Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: badge wasn't showing the latest job run from master #633

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

README: badge wasn't showing the latest job run from master #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62cc3f0
readme: badge wasn't showing the latest job run from master
maelvls Dec 2, 2024
2b956c8
actions: the tests workflow wasn't being run on the master branch
maelvls Dec 2, 2024
e544700
readme: add govulncheck and checking github action to release process
maelvls Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: tests
on:
push:
branches: [main]
branches: [master]
pull_request: {}
jobs:
verify:
Expand Down
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![tests](https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml/badge.svg)](https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml)
[![tests](https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml/badge.svg?branch=master&event=push)](https://github.com/jetstack/jetstack-secure/actions/workflows/tests.yaml)
[![Go Reference](https://pkg.go.dev/badge/github.com/jetstack/jetstack-secure.svg)](https://pkg.go.dev/github.com/jetstack/jetstack-secure)
[![Go Report Card](https://goreportcard.com/badge/github.com/jetstack/jetstack-secure)](https://goreportcard.com/report/github.com/jetstack/jetstack-secure)

Expand Down Expand Up @@ -102,26 +102,35 @@ The release process is semi-automated.
> - Create a draft GitHub release,
> - Upload the Helm chart tarball to the GitHub release.

1. Create a tag for the new release:
1. Open the [tests GitHub Actions workflow][tests-workflow]
and verify that it succeeds on the master branch.
2. Run govulncheck:
```bash
go install golang.org/x/vuln/cmd/govulncheck@latest
govulncheck -v ./...
```
3. Create a tag for the new release:
Copy link
Member

@wallrj wallrj Dec 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The govulncheck action is broken

https://github.com/jetstack/jetstack-secure/actions/workflows/govulncheck.yaml

[govulncheck: pkg/client/client_venconn.go#L14](https://github.com/jetstack/jetstack-secure/commit/2d13638d7f1a7d149d625ce1127fb95c4a5d1809#annotation_29287405002)
github.com/jetstack/[email protected]: invalid version: git ls-remote -q origin in /home/runner/go/pkg/mod/cache/vcs/e1445deb79b4ca14ee954e0f79f4034748b368f02a81510920a656b6ce2c6380: exit status 128:

So until we fix that, we have to run govulncheck manually before releasing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can fix that in another PR:

```sh
export VERSION=v1.1.0
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
git push origin "${VERSION}"
```
2. Wait until the GitHub Actions finishes.
3. Navigate to the GitHub Releases page and select the draft release to edit.
4. Wait until the GitHub Actions finishes.
5. Navigate to the GitHub Releases page and select the draft release to edit.
1. Click on “Generate release notes” to automatically compile the changelog.
2. Review and refine the generated notes to ensure they’re clear and useful
for end users.
3. Remove any irrelevant entries, such as “update deps,” “update CI,” “update
docs,” or similar internal changes that do not impact user functionality.
4. Publish the release.
5. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
6. Publish the release.
7. Inform the `#venctl` channel that a new version of Venafi Kubernetes Agent has been
released. Make sure to share any breaking change that may affect `venctl connect`
or `venctl generate`.
7. Inform Michael McLoughlin of the new release so he can update the
8. Inform Michael McLoughlin of the new release so he can update the
documentation at <https://docs.venafi.cloud/>.

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

> [!NOTE]
>
> For context, the new tag will create the following images:
Expand Down
Loading