From 4431c13d842b67e0e5f593b0a21102c189c22956 Mon Sep 17 00:00:00 2001 From: Adam Pickering Date: Thu, 10 Oct 2024 11:18:41 -0600 Subject: [PATCH] Update documentation around deprecating and hiding packages --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1fd912372..2ac018c75 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ Options for `upstream.yaml` | ArtifactHubRepo | ArtifactHubPackage | Defines the repo to access on Artifact Hub | AutoInstall | | Allows setting a required additional chart to deploy prior to current chart, such as a dedicated CRDs chart | ChartMetadata | | Allows setting/overriding the value of any valid [Chart.yaml variable](https://helm.sh/docs/topics/charts/#the-chartyaml-file) -| Deprecated | | Whether the package is deprecated. Deprecated packages will not integrate any new chart versions from upstream +| Deprecated | | Whether the package is deprecated. Deprecated packages will not integrate any new chart versions from upstream. Do not set this field directly; instead, use `partner-charts-ci deprecate`. | DisplayName | | Sets the name the chart will be listed under in the Rancher UI | Experimental | | Adds the 'experimental' annotation which adds a flag on the UI entry | Fetch | HelmChart, HelmRepo | Selects set of charts to pull from upstream.
- **latest** will pull only the latest chart version *default*
- **newer** will pull all newer versions than currently stored
- **all** will pull all versions @@ -198,7 +198,7 @@ Options for `upstream.yaml` | GitSubdirectory | GitRepo | Allows selection of a subdirectory of the upstream git repo to pull the chart from | HelmChart | HelmRepo | Defines which chart to pull from the upstream Helm repo | HelmRepo | HelmChart | Defines the upstream Helm repo to pull from -| Hidden | | Adds the 'hidden' annotation which hides the chart from the Rancher UI +| Hidden | | Adds the 'hidden' annotation which hides the chart from the Rancher UI. Do not set this field directly unless the package is new; instead, use `partner-charts-ci hide`. | Namespace | | Addes the 'namespace' annotation which hard-codes a deployment namespace for the chart | PackageVersion | | Used to generate new patch version of chart | ReleaseName | | Sets the value of the release-name Rancher annotation. Defaults to the chart name