You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+74-51Lines changed: 74 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,38 +2,87 @@
2
2
3
3
Argo Helm is a collection of **community maintained** charts. Therefore we rely on you to test your changes sufficiently.
4
4
5
-
6
-
# Pull Requests
5
+
## Pull Requests
7
6
8
7
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests. See the above stated requirements for PR on this project.
9
8
9
+
### Pull Request Title Linting
10
+
11
+
We lint the title of your pull request to ensure it follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. This is done using GitHub actions and the [action-semantic-pull-request](.github/workflows/pr-title.yml) workflow. We require the scope of the change to be included in the title. The scope should be the name of the chart you are changing. For example, if you are changing the `argo-cd` chart, the title of your pull request should be `fix(argo-cd): Fix typo in values.yaml`.
12
+
13
+
## Documentation
14
+
15
+
The documentation for each chart is generated with [helm-docs](https://github.com/norwoodj/helm-docs). This way we can ensure that values are consistent with the chart documentation.
16
+
17
+
We have a script on the repository which will execute the helm-docs docker container, so that you don't have to worry about downloading the binary etc. Simply execute the script (Bash compatible, might require sudo privileges):
18
+
19
+
```shell
20
+
./scripts/helm-docs.sh
21
+
```
22
+
23
+
> **Note**
24
+
> When creating your own `README.md.gotmpl`, don't forget to add it to your `.helmignore` file.
25
+
26
+
### Updating a chart README.md
27
+
28
+
When updating the `README.md.gotmpl` inside a chart directory you must to run the `helm-docs` script to generate the updated `README.md` file. To reiterate, you should not edit the `README.md` file manually. It will be generated by the following command:
29
+
30
+
```shell
31
+
./scripts/helm-docs.sh
32
+
```
33
+
34
+
> **Note**
35
+
> If you see changes to unrelated chart `README.md` files you may have accidentally updated a `README.md.gotmpl` file in another chart's folder unintentionally or someone else failed to run this script. Please revert those changes if you do not intend them to be a part of your pull request.
36
+
10
37
## Versioning
11
38
12
-
Each chart's version follows the [semver standard](https://semver.org/). New charts should start at version `1.0.0`, if it's considered stable. If it's not considered stable, it must be released as [prerelease](#prerelease).
39
+
Each chart's version follows the [semver standard](https://semver.org/).
40
+
41
+
New charts should start at version `1.0.0`, if it's considered stable. If it isn't considered stable, it must be released as `prerelease`.
13
42
14
43
Any breaking changes to a chart (backwards incompatible) require:
15
44
16
-
* Bump of the current Major version of the chart
17
-
* State possible manual changes for this chart version in the `Upgrading` section of the chart's `README.md.gotmpl` ([See Upgrade](#upgrades))
45
+
* Bump of the current Major version of the chart
46
+
* State possible manual changes for this chart version in the `Upgrading` section of the chart's `README.md.gotmpl`
47
+
48
+
### New Application Versions
49
+
50
+
When selecting new application versions ensure you make the following changes:
51
+
52
+
*`values.yaml`: Bump all instances of the container image version
53
+
*`Chart.yaml`: Ensure `appVersion` matches the above container image and bump `version`
54
+
55
+
Please ensure chart version changes adhere to semantic versioning standards:
56
+
57
+
* Major: Large chart rewrites, major non-backwards compatible or destructive changes
58
+
* Minor: New chart functionality (sidecars), major application updates or minor non-backwards compatible changes
59
+
* Patch: App version patch updates, backwards compatible optional chart features
18
60
19
61
### Immutability
20
62
21
63
Each release for each chart must be immutable. Any change to a chart (even just documentation) requires a version bump. Trying to release the same version twice will result in an error.
22
64
65
+
### Chart Versioning
66
+
67
+
Currently we require a chart version bump for every change to a chart, including updating information for older verions. This may change in the future.
23
68
24
69
### Artifact Hub Annotations
25
70
26
71
Since we release our charts on Artifact Hub we encourage making use of the provided chart annotations for Artifact Hub.
We want to deliver transparent chart releases for our chart consumers. Therefore we require a changelog per new chart release.
33
78
34
-
Changes on a chart must be documented in a chart specific changelog in the `Chart.yaml`[Annotation Section](https://helm.sh/docs/topics/charts/#the-chartyaml-file). For every new release the entire `artifacthub.io/changes` needs to be rewritten. Each change requires a new bullet point following the pattern `- "[{type}]: {description}"`. You can use the following template:
79
+
Changes on a chart must be documented in a chart specific changelog in the `Chart.yaml`[Annotation Section](https://helm.sh/docs/topics/charts/#the-chartyaml-file).
35
80
36
-
```
81
+
A new `artifacthub.io/changes` needs to be written covering only the changes since the previous release.
82
+
83
+
Each change requires a new bullet point following the pattern `- "[{type}]: {description}"`. You can use the following template:
84
+
85
+
```yaml
37
86
name: argo-cd
38
87
version: 3.4.1
39
88
...
@@ -45,67 +94,54 @@ annotations:
45
94
- "[Deprecated]: Something deprecated"
46
95
- "[Removed]: Something was removed"
47
96
- "[Fixed]: Something was fixed"
48
-
- "[Security]": Some Security Patch was included"
97
+
- "[Security]: Some Security Patch was included"
49
98
```
50
99
51
-
## Documentation
52
-
53
-
The documentation for each chart is done with [helm-docs](https://github.com/norwoodj/helm-docs). This way we can ensure that values are consistent with the chart documentation.
100
+
## Testing
54
101
55
-
We have a script on the repository which will execute the helm-docs docker container, so that you don't have to worry about downloading the binary etc. Simply execute the script (Bash compatible, might require sudo privileges):
56
-
57
-
```
58
-
bash scripts/helm-docs.sh
59
-
```
60
-
61
-
**NOTE**: When creating your own `README.md.gotmpl`, don't forget to add it to your `.helmignore` file.
62
-
63
-
64
-
65
-
# Testing
66
-
67
-
## Testing Argo Workflows Changes
102
+
### Testing Argo Workflows Changes
68
103
69
104
Minimally:
70
105
71
-
```
106
+
```shell
72
107
helm install charts/argo-workflows -n argo
73
108
argo version
74
109
```
75
110
76
111
Follow this instructions for running a hello world workflow.
When raising application versions ensure you make the following changes:
125
-
126
-
-`values.yaml`: Bump all instances of the container image version
127
-
-`Chart.yaml`: Ensure `appVersion` matches the above container image and bump `version`
128
-
129
-
Please ensure chart version changes adhere to semantic versioning standards:
130
-
131
-
- Patch: App version patch updates, backwards compatible optional chart features
132
-
- Minor: New chart functionality (sidecars), major application updates or minor non-backwards compatible changes
133
-
- Major: Large chart rewrites, major non-backwards compatible or destructive changes
134
-
135
-
## Testing Charts
158
+
### Testing Charts
136
159
137
160
As part of the Continuous Integration system we run Helm's [Chart Testing](https://github.com/helm/chart-testing) tool.
138
161
139
-
The checks for this tool are stricter than the standard Helm requirements, where fields normally considered optional like `maintainer` are required in the standard spec and must be valid GitHub usernames.
162
+
The checks for Chart Testing are stricter than the standard Helm requirements. For example, fields normally considered optional like `maintainer` are required in the standard spec and must be valid GitHub usernames.
140
163
141
164
Linting configuration can be found in [ct-lint.yaml](./.github/configs/ct-lint.yaml)
142
165
143
166
The linting can be invoked manually with the following command:
144
167
145
-
```
168
+
```shell
146
169
./scripts/lint.sh
147
170
```
148
171
149
172
## Publishing Changes
150
173
151
-
Changes are automatically publish whenever a commit is merged to main. The CI job (see `./.github/workflows/publish.yml`).
174
+
Changes are automatically publish whenever a commit is merged to the `main` branch by the CI job (see `./.github/workflows/publish.yml`).
Copy file name to clipboardExpand all lines: charts/argo-cd/README.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,8 +111,9 @@ This version reduces history limit for Argo CD deployment replicas to 3 to provi
111
111
112
112
### 5.12.0
113
113
114
-
This version deprecates the `configs.secret.argocdServerTlsConfig` option. Use `server.certificate` or `server.certificateSecret` to provide custom TLS configuration for Argo CD server.
115
-
If you terminate TLS on ingress please use `argocd-server-tls` secret instead of `argocd-secret` secret.
114
+
If Argo CD is managing termination of TLS and you are using `configs.secret.argocdServerTlsConfig` option to provide custom TLS configuration for this chart, please use `server.certificate` or `server.certificateSecret` instead.
115
+
For the secrets for tls termination, please use a secret named `argocd-server-tls` instead of `argocd-secret`.
116
+
For the technical details please check the [Argo CD documentation](https://argo-cd.readthedocs.io/en/stable/operator-manual/tls/#tls-certificates-used-by-argocd-server). When transitioning from the one secret to the other pay attention to `tls.key` and `tls.crt` keys.
Copy file name to clipboardExpand all lines: charts/argo-cd/README.md.gotmpl
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -110,8 +110,9 @@ This version reduces history limit for Argo CD deployment replicas to 3 to provi
110
110
111
111
### 5.12.0
112
112
113
-
This version deprecates the `configs.secret.argocdServerTlsConfig` option. Use `server.certificate` or `server.certificateSecret` to provide custom TLS configuration for Argo CD server.
114
-
If you terminate TLS on ingress please use `argocd-server-tls` secret instead of `argocd-secret` secret.
113
+
If Argo CD is managing termination of TLS and you are using `configs.secret.argocdServerTlsConfig` option to provide custom TLS configuration for this chart, please use `server.certificate` or `server.certificateSecret` instead.
114
+
For the secrets for tls termination, please use a secret named `argocd-server-tls` instead of `argocd-secret`.
115
+
For the technical details please check the [Argo CD documentation](https://argo-cd.readthedocs.io/en/stable/operator-manual/tls/#tls-certificates-used-by-argocd-server). When transitioning from the one secret to the other pay attention to `tls.key` and `tls.crt` keys.
0 commit comments