Skip to content

Update Helm README version phrasing #1028

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

Merged
merged 1 commit into from
Sep 1, 2023
Merged

Update Helm README version phrasing #1028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 12 additions & 3 deletions deploy/helm-chart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,24 @@ To install the chart with the release name `my-release` (`my-release` is the nam
nginx-gateway namespace (with optional `--create-namespace` flag - you can omit if the namespace already exists):

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

This will install the latest stable release. To install the latest version from the `main` branch, specify the
`--version 0.0.0-edge` flag when installing.

### Installing the Chart via Sources

#### Pulling the Chart

```shell
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar --version 0.0.0-edge
helm pull oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --untar
cd nginx-kubernetes-gateway
```

This will pull the latest stable release. To pull the latest version from the `main` branch, specify the
`--version 0.0.0-edge` flag when pulling.

#### Installing the Chart

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

```shell
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway --version 0.0.0-edge -n nginx-gateway
helm upgrade my-release oci://ghcr.io/nginxinc/charts/nginx-kubernetes-gateway -n nginx-gateway
```

This will upgrade to the latest stable release. To upgrade to the latest version from the `main` branch,
specify the `--version 0.0.0-edge` flag when upgrading.

### Upgrading the Chart from the Sources

Pull the chart sources as described in [Pulling the Chart](#pulling-the-chart), if not already present. Then, to upgrade
Expand Down
18 changes: 8 additions & 10 deletions docs/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,17 @@ To create a new release, follow these steps:
6. Prepare and merge a PR into the release branch to update the repo files for the release:
1. Update the Helm [Chart.yaml](../deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source
URLs to point at `vX.Y.Z`, and bump the `version`.
2. Update the Helm [README](../deploy/helm-chart/README.md) `--version` flags in the helm commands to use the stable
`version` from the previous step.
3. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NKG_TAG` in the
2. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NKG_TAG` in the
[conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`.
4. Update the tag of NKG container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the
3. Update the tag of NKG container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the
[provisioner manifest](../conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
5. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml)
4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml)
file.
6. Generate the installation manifests by running `make generate-manifests`.
7. Modify any `git clone` instructions to use `vX.Y.Z` tag.
8. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
9. Update the [README](../README.md) to include information about the release.
10. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
5. Generate the installation manifests by running `make generate-manifests`.
6. Modify any `git clone` instructions to use `vX.Y.Z` tag.
7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
8. Update the [README](../README.md) to include information about the release.
9. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. As
a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the
full changelog. This draft can be found under
Expand Down