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
+9-9
Original file line number
Diff line number
Diff line change
@@ -36,22 +36,22 @@ bump even if it is only changed to the documentation.
36
36
37
37
The chart `version` should follow [semver](https://semver.org/).
38
38
39
-
Charts should start at `0.1.0` or `1.0.0`. Any breaking (backwards incompatible)
40
-
changes to a chart should:
39
+
All changes to a chart require a version bump, following semvar.
41
40
42
-
1. Bump the MAJOR version
41
+
Any breaking (backwards incompatible) changes to a chart should:
42
+
1. Bump the MINOR version
43
43
2. In the README, under a section called "Upgrading", describe the manual steps
44
44
necessary to upgrade to the new (specified) MAJOR version
45
45
46
-
### Adding new examples
46
+
### Examples
47
47
48
-
New examples should be added as independent folders in the respective chart's `examples` folder. Examples should always contain a `values.yaml` and a `rendered` folder.
48
+
All charts maintain examples for the current version. After updating the version, examples must be updated with the `make generate-examples` target.
49
+
50
+
The default `generate-examples` command will update all charts. In order generate a chart's examples you must have the chart's dependencies added to your helm repo.
49
51
50
-
To generate the rendered files run:
52
+
If you need update a single chart's examples you can use the `CHARTS` variable. For example, if you want to update only the collector chart's examples you can run`make generate-examples CHARTS=opentelemetry-collector`
51
53
52
-
```console
53
-
make generate-examples
54
-
```
54
+
New examples should be added as independent folders in the respective chart's `examples` folder. Examples should always contain a `values.yaml` and a `rendered` folder.
0 commit comments