diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 439dfa6379..ba6f4dbe60 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,8 +9,7 @@ Fixes # - [ ] Reviewed the [`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md) guide (**required**) - [ ] Documentation added - [ ] Tests updated -- [ ] `CHANGELOG.md` updated - - [ ] If the change is worth mentioning in the release notes, add `add-to-release-notes` label +- [ ] Title matches the required conventional commits format, see [here](https://www.conventionalcommits.org/en/v1.0.0/) - [ ] Changes that require user attention or interaction to upgrade are documented in `docs/sources/setup/upgrade/_index.md` - [ ] For Helm chart changes bump the Helm chart version in `production/helm/loki/Chart.yaml` and update `production/helm/loki/CHANGELOG.md` and `production/helm/loki/README.md`. [Example PR](https://github.com/grafana/loki/commit/d10549e3ece02120974929894ee333d07755d213) - [ ] If the change is deprecating or removing a configuration option, update the `deprecated-config.yaml` and `deleted-config.yaml` files respectively in the `tools/deprecated-config-checker` directory. [Example PR](https://github.com/grafana/loki/pull/10840/commits/0d4416a4b03739583349934b96f272fb4f685d15) diff --git a/.github/workflows/append-release-notes.yml b/.github/workflows/append-release-notes.yml deleted file mode 100644 index a512d6e18b..0000000000 --- a/.github/workflows/append-release-notes.yml +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Append to Release Notes -on: - pull_request_target: - types: - - closed - - labeled - -jobs: - main: - runs-on: ubuntu-latest - steps: - - name: Checkout Actions - uses: actions/checkout@v3 - with: - repository: "grafana/grafana-github-actions" - path: ./actions - ref: main - - name: Install Actions - run: npm install --production --prefix ./actions - - name: Run release notes appender - uses: ./actions/release-notes-appender - with: - metricsWriteAPIKey: ${{secrets.GRAFANA_MISC_STATS_API_KEY}} - token: ${{secrets.GH_BOT_ACCESS_TOKEN}} - labelsToAdd: "release-notes" - releaseNotesFile: docs/sources/release-notes/next.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94d664954f..798485cf0d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,19 +16,13 @@ LIDs must be created as a pull request using [this template](docs/sources/commun **NOTE:** The Loki team has adopted the use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages. -1. Your PR title is in the form `: Your change`. - 1. It does not end the title with punctuation. It will be added in the changelog. - 1. It starts with an imperative verb. Example: Fix the latency between System A and System B. - 1. It uses Sentence case, not Title Case. +1. Your PR title is in the conventional commits form `: Your change`. 1. It uses a complete phrase or sentence. The PR title will appear in a changelog, so help other people understand what your change will be. - 1. It has a clear description saying what it does and why. Your PR description will be present in the project' commit log, so be gentle to it. -1. Your PR is well sync'ed with main -1. Your PR is correctly documenting appropriate changes under the CHANGELOG. You should document your changes there if: - * It adds an important feature - * It fixes an issue present in a previous release - * It causes a change in operation that would be useful for an operator of Loki to know - * You can skip this step for documentation changes, build related changes and simple bug fixes or enhancements. Rationale being we are attempting to curate the CHANGELOG entries with the most relevant and important changes that end users of Loki care about. -1. Your PR documents upgrading steps under `docs/sources/setup/upgrade/_index.md` if it changes: + 1. It starts with an imperative verb. Example: Fix the latency between System A and System B. + 2. It uses Sentence case, not Title Case. +2. It has a clear description saying what it does and why. Your PR description is a reviewers first impression of your changes. +3. Your PR branch is sync'ed with main +4. Your PR documents upgrading steps under `docs/sources/setup/upgrade/_index.md` if it changes: * Default configuration values * Metric names or label names * Changes existing log lines that may be used in dashboard or alerts. e.g: logs lines in any `metrics.go` files might be used in building dashboards or alerts. diff --git a/docs/sources/community/maintaining/release/prepare-release-notes.md b/docs/sources/community/maintaining/release/prepare-release-notes.md index 13fb910ee9..9b16671e0e 100644 --- a/docs/sources/community/maintaining/release/prepare-release-notes.md +++ b/docs/sources/community/maintaining/release/prepare-release-notes.md @@ -22,6 +22,8 @@ Release notes are the few key highlights of the release. This is what appears on ## Steps +**This section is out of date now that we use conventional commits, to be updated (Trevor/Callum)** + 1. Discuss with Loki team to finalize what PRs should be part of release notes. 1. Go to the PR and add a label `add-to-release-notes`. Example [PR](https://github.com/grafana/loki/pull/10213) with label added.