Skip to content

Commit 8d7cfed

Browse files
authored
docs: releaseName is now required by helm-template (#3645)
Signed-off-by: Jesse Suen <[email protected]>
1 parent 9c17446 commit 8d7cfed

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/docs/50-user-guide/60-reference-docs/30-promotion-steps/helm-template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ commonly preceded by a [`git-clear` step](git-clear.md) and followed by
1717
|------|------|----------|-------------|
1818
| `path` | `string` | Y | Path to a Helm chart (i.e. to a directory containing a `Chart.yaml` file). This path is relative to the temporary workspace that Kargo provisions for use by the promotion process. |
1919
| `outPath` | `string` | Y | Path to the file or directory where rendered manifests are to be written. If the path ends with `.yaml` or `.yml` it is presumed to indicate a file and is otherwise presumed to indicate a directory. |
20-
| `releaseName` | `string` | N | Optional release name to use when rendering the manifests. This is commonly omitted. |
20+
| `releaseName` | `string` | Y | Release name to use when rendering the manifests. |
2121
| `useReleaseName` | `boolean` | N | Whether to use the release name in the output path (instead of the chart name). This is `false` by default, and only has an effect when `outPath` is set to a directory. |
2222
| `namespace` | `string` | N | Optional namespace to use when rendering the manifests. This is commonly omitted. GitOps agents such as Argo CD will generally ensure the installation of manifests into the namespace specified by their own configuration. |
2323
| `valuesFiles` | `[]string` | N | Helm values files (apart from the chart's default `values.yaml`) to be used when rendering the manifests. |

docs/old-docs/35-references/10-promotion-steps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -869,7 +869,7 @@ commonly preceded by a [`git-clear`](#git-clear) step and followed by
869869
|------|------|----------|-------------|
870870
| `path` | `string` | Y | Path to a Helm chart (i.e. to a directory containing a `Chart.yaml` file). This path is relative to the temporary workspace that Kargo provisions for use by the promotion process. |
871871
| `outPath` | `string` | Y | Path to the file or directory where rendered manifests are to be written. If the path ends with `.yaml` or `.yml` it is presumed to indicate a file and is otherwise presumed to indicate a directory. |
872-
| `releaseName` | `string` | N | Optional release name to use when rendering the manifests. This is commonly omitted. |
872+
| `releaseName` | `string` | Y | Release name to use when rendering the manifests. |
873873
| `namespace` | `string` | N | Optional namespace to use when rendering the manifests. This is commonly omitted. GitOps agents such as Argo CD will generally ensure the installation of manifests into the namespace specified by their own configuration. |
874874
| `valuesFiles` | `[]string` | N | Helm values files (apart from the chart's default `values.yaml`) to be used when rendering the manifests. |
875875
| `includeCRDs` | `boolean` | N | Whether to include CRDs in the rendered manifests. This is `false` by default. |

0 commit comments

Comments
 (0)