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
Thank you for your interest in contributing to the Loki Helm Chart! This document provides guidelines for contributing to ensure the chart remains maintainable, broadly useful, and accessible to the community.
4
+
5
+
For general Loki project contributions, please also see the main [Contributing Guide](../../../CONTRIBUTING.md).
6
+
7
+
## Contribution Guidelines
8
+
9
+
### What We Welcome
10
+
11
+
We encourage contributions that:
12
+
13
+
-**Improve general usability**: Features that benefit the majority of users
14
+
-**Fix bugs**: Clear bug fixes with reproduction steps
-**Performance optimizations**: Changes that improve performance broadly
18
+
-**Standards compliance**: Updates to follow Kubernetes best practices
19
+
20
+
### What We Avoid
21
+
22
+
To keep the chart maintainable and broadly useful, we avoid:
23
+
24
+
-**Project-specific integrations**: Features specific to other projects that serve only a small group of users
25
+
-**Company/individual-specific requirements**: Customizations that serve only specific organizations
26
+
-**Bizarre constraints**: Unusual or overly complex requirements that don't serve the general community
27
+
-**Breaking changes**: Changes that would break existing deployments without clear migration paths
28
+
29
+
### Decision Criteria
30
+
31
+
When reviewing contributions, we ask:
32
+
33
+
1.**Is this generally useful?** Does it benefit the broader community or just specific users?
34
+
2.**Is it simple and reasonable?** Does it add unnecessary complexity?
35
+
3.**Does it align with Kubernetes best practices?** Is it following established patterns?
36
+
4.**Is it maintainable?** Can the community maintain this feature long-term?
37
+
38
+
**Important**: If your use case is highly specific to your organization, consider using the Loki chart as a subchart instead of being called directly. This allows you to customize without adding complexity to the main chart.
39
+
40
+
## Technical Requirements
41
+
42
+
### Before Submitting a PR
43
+
44
+
1.**Update documentation**: Run `make helm-docs` from the repository root if you modified:
45
+
-`Chart.yaml`
46
+
-`values.yaml`
47
+
- Any template files
48
+
49
+
2.**Update the changelog**: Add an entry to [CHANGELOG.md](./CHANGELOG.md) in the `Unreleased` section using the format:
50
+
```
51
+
- [CHANGE|FEATURE|BUGFIX|ENHANCEMENT] Brief description of your change, and a link to the PR number. For examples, see the CHANGELOG.
52
+
```
53
+
54
+
3.**Test your changes**: The CICD workflow will run comprehensive tests, however it's a good idea to run a few "quick and dirty" tests locally before committing, as those workflows can take quite a while in comparison.
55
+
- Single binary: `helm template --values single-binary-values.yaml`
4.**Commit your changes**: Our commits follow the style of [Conventional Commits](https://www.conventionalcommits.org/). High level this looks like `<type>: description`. For example:
60
+
-`feat(helm): add resource limits to querier`
61
+
-`fix(helm): correct service selector`
62
+
63
+
Thank you for contributing to the Loki Helm Chart! Your contributions help make log aggregation accessible to the entire community.
Helm chart for Grafana Loki and Grafana Enterprise Logs supporting monolithic, simple scalable, and microservices modes.
6
6
7
+
## ⚠️ Helm Chart Migration
8
+
Effective March 16, 2026, the Grafana Loki Helm chart will be forked to a new repository [grafana-community/helm-charts](https://github.com/grafana-community/helm-charts). The chart in the Loki repository will continue to be maintained for GEL users only. See [#20705](https://github.com/grafana/loki/issues/20705) for details.
9
+
7
10
## Source Code
8
11
9
12
*<https://github.com/grafana/loki>
@@ -15,51 +18,18 @@ Helm chart for Grafana Loki and Grafana Enterprise Logs supporting monolithic, s
Find more information in the Loki Helm Chart [documentation](https://grafana.com/docs/loki/next/installation/helm).
22
-
23
-
## Contributing and releasing
24
-
25
-
If you made any changes to the [Chart.yaml](https://github.com/grafana/loki/blob/main/production/helm/loki/Chart.yaml) or [values.yaml](https://github.com/grafana/loki/blob/main/production/helm/loki/values.yaml) run `make helm-docs` from the root of the repository to update the documentation and commit the changed files.
26
-
27
-
Futhermore, please add an entry to the [CHANGELOG.md](./CHANGELOG.md) file about what you changed. This file has a header that looks like this:
28
-
29
-
```
30
-
[//]: # (<AUTOMATED_UPDATES_LOCATOR> : do not remove this line. This locator is used by the CI pipeline to automatically create a changelog entry for each new Loki release. Add other chart versions and respective changelog entries bellow this line.)
31
-
````
32
-
33
-
Place your changes as a bulleted list below this header. The helm chart is automatically released once a week, at which point the `CHANGELOG.md` file will be updated to reflect the release of all changes between this header the the header of the previous version as the changes for that weeks release. For example, if the weekly release will be `1.21.0`, and the `CHANGELOG.md` file has the following entries:
34
-
35
-
```
36
-
[//]: #(<AUTOMATED_UPDATES_LOCATOR> : do not remove this line. This locator is used by the CI pipeline to automatically create a changelog entry for each new Loki release. Add other chart versions and respective changelog entries bellow this line.)
37
-
38
-
-[CHANGE] Changed the thing
39
-
-[FEATURE] Cool new feature
40
-
41
-
## 1.20.0
42
-
43
-
-[BUGFIX] Fixed the bug
44
-
```
45
-
46
-
Then the weekly release will create a `CHANGELOG.md` with the following content:
47
-
```
48
-
[//]: #(<AUTOMATED_UPDATES_LOCATOR> : do not remove this line. This locator is used by the CI pipeline to automatically create a changelog entry for each new Loki release. Add other chart versions and respective changelog entries bellow this line.)
Find more information in the Loki Helm Chart [documentation](https://grafana.com/docs/loki/latest/setup/install/helm/).
54
25
55
-
## 1.20.0
26
+
## Contributing
56
27
57
-
-[BUGFIX] Fixed the bug
58
-
```
28
+
Please see our [Helm Contributing Guidelines](./CONTRIBUTING.md) for detailed information about contributing to the Loki Helm Chart.
59
29
60
-
#### Versioning
30
+
##Releases
61
31
62
-
Normally contributors need _not_ bump the version nor update the [CHANGELOG.md](https://github.com/grafana/loki/blob/main/production/helm/loki/CHANGELOG.md). A new version of the Chart will follow this cadence:
32
+
Normally, contributors need _not_ bump the Chart version. A new version of the Chart will follow this cadence:
63
33
- Automatic weekly releases
64
34
- Releases that coincide with Loki/GEL releases
65
35
- Manual releases when necessary (ie. to address a CVE or critical bug)
0 commit comments