Skip to content

Commit aa00a8e

Browse files
add breaking change notice to the README.md
1 parent f3dd609 commit aa00a8e

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

charts/gitops-runtime/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ annotations:
1515
artifacthub.io/alternativeName: "codefresh-gitops-runtime"
1616
artifacthub.io/changes: |-
1717
- kind: changed
18-
description: 'feat: update to upstream argo-cd 2.12.3 and helm 7.4.7 (#281)'
18+
description: 'feat: update to upstream argo-cd 2.12.3 and helm 7.4.7 (#281). Contains a BREAKING CHANGE in the chart -- see the README.md'
1919
- kind: changed
2020
description: 'update gitops-operator to `0.2.12` - fix: action script fails to extract commit_sha from response (#285)'
2121
- kind: changed

charts/gitops-runtime/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@ See [Use OCI-based registries](https://helm.sh/docs/topics/registries/)
1616
## Codefresh official documentation:
1717
Prior to running the installation please see the official documentation at: https://codefresh.io/docs/docs/installation/gitops/hybrid-gitops-helm-installation/
1818

19+
## WARNING! ARGO-CD 7.x.x CHART BREAKING CHANGE
20+
21+
In the runtime release `0.12.0` we upgraded to the latest argo-cd `7.x.x` helm chart which
22+
contains the breaking change in the values for providing cluster credentials
23+
(in this chart it's located under the path `argo-cd.configs.clusterCredentials`).
24+
`clusterCredentials` used to be of type `list` -- now it's a `map` (`object`).
25+
See the [release notes](https://github.com/argoproj/argo-helm/releases/tag/argo-cd-7.0.0).
26+
27+
Codefresh Gitops Runtime does NOT use these values directly -- so the runtimes
28+
with the default configuration are not affected.
29+
1930
## Using with private registries - Helper utility
2031
The GitOps Runtime comprises multiple subcharts and container images. Subcharts also vary in values structure, making it difficult to override image specific values to use private registries.
2132
We have created a helper utility to resolve this issue:

0 commit comments

Comments
 (0)