Skip to content

Commit ab3c6af

Browse files
authored
Update Helm README version phrasing (#1028)
Problem: Users who visit our main branch intending to install Helm may not understand how to get the latest stable version, since we only mention how to install the edge version. Solution: Omit the version field in the examples, which will install the latest stable version. Mention how a user can install the edge version. Also updated the release process doc to no longer require any updates to the Helm README, since it can apply to all releases now.
1 parent b55d1bc commit ab3c6af

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

deploy/helm-chart/README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,24 @@ To install the chart with the release name `my-release` (`my-release` is the nam
3030
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists):
3131

3232
```shell
33-
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge --create-namespace --wait -n nginx-gateway
33+
helm install my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --create-namespace --wait -n nginx-gateway
3434
```
3535

36+
This will install the latest stable release. To install the latest version from the `main` branch, specify the
37+
`--version 0.0.0-edge` flag when installing.
38+
3639
### Installing the Chart via Sources
3740

3841
#### Pulling the Chart
3942

4043
```shell
41-
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar --version 0.0.0-edge
44+
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar
4245
cd nginx-kubernetes-gateway
4346
```
4447

48+
This will pull the latest stable release. To pull the latest version from the `main` branch, specify the
49+
`--version 0.0.0-edge` flag when pulling.
50+
4551
#### Installing the Chart
4652

4753
To install the chart with the release name `my-release` (`my-release` is the name that you choose) into the
@@ -83,9 +89,12 @@ Warning: kubectl apply should be used on resource created by either kubectl crea
8389
To upgrade the release `my-release`, run:
8490

8591
```shell
86-
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge -n nginx-gateway
92+
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway -n nginx-gateway
8793
```
8894

95+
This will upgrade to the latest stable release. To upgrade to the latest version from the `main` branch,
96+
specify the `--version 0.0.0-edge` flag when upgrading.
97+
8998
### Upgrading the Chart from the Sources
9099

91100
Pull the chart sources as described in [Pulling the Chart](#pulling-the-chart), if not already present. Then, to upgrade

docs/release-process.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,17 @@ To create a new release, follow these steps:
3434
6. Prepare and merge a PR into the release branch to update the repo files for the release:
3535
1. Update the Helm [Chart.yaml](../deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source
3636
URLs to point at `vX.Y.Z`, and bump the `version`.
37-
2. Update the Helm [README](../deploy/helm-chart/README.md) `--version` flags in the helm commands to use the stable
38-
`version` from the previous step.
39-
3. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NKG_TAG` in the
37+
2. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NKG_TAG` in the
4038
[conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`.
41-
4. Update the tag of NKG container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the
39+
3. Update the tag of NKG container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the
4240
[provisioner manifest](../conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
43-
5. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml)
41+
4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml)
4442
file.
45-
6. Generate the installation manifests by running `make generate-manifests`.
46-
7. Modify any `git clone` instructions to use `vX.Y.Z` tag.
47-
8. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
48-
9. Update the [README](../README.md) to include information about the release.
49-
10. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
43+
5. Generate the installation manifests by running `make generate-manifests`.
44+
6. Modify any `git clone` instructions to use `vX.Y.Z` tag.
45+
7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
46+
8. Update the [README](../README.md) to include information about the release.
47+
9. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
5048
changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. As
5149
a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the
5250
full changelog. This draft can be found under

0 commit comments

Comments
 (0)