Skip to content

Commit fc048e7

Browse files
authored
readme: move informative stuff out of the list of actions in the release process
1 parent 1a567ef commit fc048e7

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,17 +94,21 @@ The release process is semi-automated.
9494

9595
### Step 1: Git Tag and GitHub Release
9696

97+
> [!NOTE]
98+
>
99+
> Upon pushing the tag, a GitHub Action will do the following:
100+
> - Build and publish the container image at `quay.io/jetstack/venafi-agent`,
101+
> - Build and publish the Helm chart at `oci://quay.io/jetstack/charts/venafi-kubernetes-agent`,
102+
> - Create a draft GitHub release,
103+
> - Upload the Helm chart tarball to the GitHub release.
104+
97105
1. Create a tag for the new release:
98106
```sh
99107
export VERSION=v1.1.0
100108
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
101109
git push origin "${VERSION}"
102110
```
103-
2. A GitHub action will see the new tag and do the following:
104-
- Build and publish the container image at `quay.io/jetstack/venafi-agent`,
105-
- Build and publish the Helm chart at `oci://quay.io/jetstack/charts/venafi-kubernetes-agent`,
106-
- Create a draft GitHub release,
107-
- Upload the Helm chart tarball to the GitHub release.
111+
2. Wait until the GitHub Actions finishes.
108112
3. Navigate to the GitHub Releases page and select the draft release to edit.
109113
1. Click on “Generate release notes” to automatically compile the changelog.
110114
2. Review and refine the generated notes to ensure they’re clear and useful

0 commit comments

Comments
 (0)