Skip to content

Commit 4c95083

Browse files
committed
readme: release process: push git tag before editing the release
1 parent 8f1cb99 commit 4c95083

File tree

1 file changed

+40
-23
lines changed

1 file changed

+40
-23
lines changed

README.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,28 @@ The Helm charts are:
9292
9393
The release process is semi-automated.
9494

95-
### Step 1: Incrementing Versions And Git Tag
96-
97-
1. Go to the GitHub Releases page and click "Draft a New Release".
98-
- Click "Create a new tag" with the version number prefixed with `v` (e.g., `v1.1.0`).
99-
- Use the title "v1.1.0",
100-
- Click "Generate Release Notes"
101-
- Edit the release notes to make them readable to the end-user.
102-
- Click "Publish" (don't select "Draft")
103-
2. Inform Michael McLoughlin of the new release so he can update the
95+
### Step 1: Git Tag and GitHub Release
96+
97+
1. Create a tag for the new release:
98+
```sh
99+
export VERSION=v0.6.0-alpha.0
100+
git tag --annotate --message="Release ${VERSION}" "${VERSION}"
101+
git push origin "${VERSION}"
102+
```
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.
108+
3. Navigate to the GitHub Releases page and select the draft release to edit.
109+
2. Click on “Generate release notes” to automatically compile the changelog.
110+
3. Review and refine the generated notes to ensure they’re clear and useful
111+
for end users.
112+
4. Remove any irrelevant entries, such as “update deps,” “update CI,”
113+
“update docs,” or similar internal changes that do not impact user
114+
functionality.
115+
4. Publish the release.
116+
5. Inform Michael McLoughlin of the new release so he can update the
104117
documentation at <https://docs.venafi.cloud/>.
105118

106119
> [!NOTE]
@@ -166,16 +179,24 @@ NOTE(mael): TBD
166179
This step is performed by Peter Fiddes and Adrian Lai separately from the main
167180
release process.
168181
169-
Run the Helm Chart workflow
170-
[release_js-agent_chart.yaml](https://github.com/jetstack/enterprise-builds/actions/workflows/release_js-agent_chart.yaml).
182+
The `jetstack-secure` chart is for [Jetstack
183+
Secure](https://platform.jetstack.io/documentation/installation/agent#jetstack-agent-helm-chart-installation).
184+
It is composed of two OCI Helm charts:
185+
186+
- `oci://eu.gcr.io/jetstack-secure-enterprise/charts/jetstack-agent`
187+
- `oci://us.gcr.io/jetstack-secure-enterprise/charts/jetstack-agent`
171188
172-
The [jetstack-agent](deploy/charts/jetstack-agent/README.md) chart has a different version number to the agent.
173-
This is because the first version of _this_ chart was given version `0.1.0`,
174-
while the app version at the time was `0.1.38`.
175-
And this allows the chart to be updated and released more frequently than the Docker image if necessary.
176-
This chart is for [Jetstack Secure](https://platform.jetstack.io/documentation/installation/agent#jetstack-agent-helm-chart-installation).
189+
> [!NOTE]
190+
>
191+
> The [jetstack-agent](deploy/charts/jetstack-agent/README.md) chart has a
192+
> different version number to the agent. This is because the first version of
193+
> _this_ chart was given version `0.1.0`, while the app version at the time was
194+
> `0.1.38`. And this allows the chart to be updated and released more frequently
195+
> than the Docker image if necessary.
177196
178-
1. Create a branch
197+
The process is as follows:
198+
199+
1. Create a branch.
179200
2. Increment version numbers.
180201
1. Increment the `version` value in [Chart.yaml](deploy/charts/jetstack-agent/Chart.yaml).
181202
DO NOT use a `v` prefix.
@@ -190,10 +211,6 @@ This chart is for [Jetstack Secure](https://platform.jetstack.io/documentation/i
190211
```
191212
3. Create a pull request and wait for it to be approved.
192213
4. Merge the branch
193-
5. Push a tag, using the format: `chart-vX.Y.Z`.
194-
This unique tag format is recognized by the private CI pipeline that builds and publishes the chart.
195-
196-
The chart will be published to
197-
the [Jetstack Enterprise Registry](https://platform.jetstack.io/documentation/installation/agent#1-obtain-oci-registry-credentials)
198-
by a private CI pipeline managed by Venafi.
214+
5. Manually trigger the Helm Chart workflow:
215+
[release_js-agent_chart.yaml](https://github.com/jetstack/enterprise-builds/actions/workflows/release_js-agent_chart.yaml).
199216

0 commit comments

Comments
 (0)