Skip to content

Commit

Permalink
docs: update contributing guidelines for the helm chart (#14523)
Browse files Browse the repository at this point in the history
  • Loading branch information
trevorwhitney authored Oct 18, 2024
1 parent 3d67208 commit 09dc7cf
Show file tree
Hide file tree
Showing 3 changed files with 68 additions and 0 deletions.
2 changes: 2 additions & 0 deletions production/helm/loki/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Entries should include a reference to the pull request that introduced the chang

## 6.18.0

- [CHANGE] Added automated weekly releases, which created this release.

## 6.17.1

- [BUGFIX] Added missing `loki.storage.azure.chunkDelimiter` parameter to Helm chart.
Expand Down
33 changes: 33 additions & 0 deletions production/helm/loki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,39 @@ Find more information in the Loki Helm Chart [documentation](https://grafana.com

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.

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:

```
[//]: # (<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.)
````

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:

```
[//]: # (<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.)
- [CHANGE] Changed the thing
- [FEATURE] Cool new feature
## 1.20.0
- [BUGFIX] Fixed the bug
```

Then the weekly release will create a `CHANGELOG.md` with the following content:
```
[//]: # (<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.)
## 1.21.0
- [CHANGE] Changed the thing
- [FEATURE] Cool new feature
## 1.20.0
- [BUGFIX] Fixed the bug
```

#### Versioning

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:
Expand Down
33 changes: 33 additions & 0 deletions production/helm/loki/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,39 @@ Find more information in the Loki Helm Chart [documentation](https://grafana.com

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.

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:

```
[//]: # (<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.)
````

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:

```
[//]: # (<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.)

- [CHANGE] Changed the thing
- [FEATURE] Cool new feature

## 1.20.0

- [BUGFIX] Fixed the bug
```

Then the weekly release will create a `CHANGELOG.md` with the following content:
```
[//]: # (<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.)

## 1.21.0

- [CHANGE] Changed the thing
- [FEATURE] Cool new feature

## 1.20.0

- [BUGFIX] Fixed the bug
```

#### Versioning

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:
Expand Down

0 comments on commit 09dc7cf

Please sign in to comment.