From 6e3e59fa73489337198abad03d0f09a796d5bf0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=E1=B4=87=CA=80=C9=B4=E1=B4=85=20S=E1=B4=84=CA=9C?= =?UTF-8?q?=E1=B4=8F=CA=80=C9=A2=E1=B4=87=CA=80s?= Date: Fri, 4 Feb 2022 10:48:22 +0100 Subject: [PATCH] chore: Update PR template MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++-- .github/label-commenter-config.yml | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5a9148a6..c908a242 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -32,8 +32,9 @@ Also don't be worried if the request is closed or not integrated sometimes our p **Checklist** -- [ ] Chart version bumped in `Chart.yaml` according to [semver](http://semver.org/). - [ ] Title of the PR starts with chart name (e.g. `[home-assistant]`) -- [ ] Variables are documented in the README.md (this can be done with using our helm-docs wrapper `./hack/gen-helm-docs.sh stable `) +- [ ] Chart version bumped in `Chart.yaml` according to [semver](http://semver.org/). +- [ ] Chart `artifacthub.io/changes` changelog annotation has been updated in `Chart.yaml`. See [Artifact Hub documentation](https://artifacthub.io/docs/topics/annotations/helm/#supported-annotations) for more info. +- [ ] Variables have been documented in the `values.yaml` file. diff --git a/.github/label-commenter-config.yml b/.github/label-commenter-config.yml index 254b2b07..ec8613d8 100644 --- a/.github/label-commenter-config.yml +++ b/.github/label-commenter-config.yml @@ -31,5 +31,5 @@ labels: We have noticed that the chart documentation has not been completely updated for this PR. Could you please make sure that the following items have been updated: - `version` in `Chart.yaml` has been updated per [semver](http://semver.org/) - - The `artifacthub.io/changes` chart annotation contains a summary of the updates for this new version. ([Artifact Hub documentation](https://artifacthub.io/docs/topics/annotations/helm/#supported-annotations)) + - The `artifacthub.io/changes` chart annotation contains a summary of the updates for this new version. See [Artifact Hub documentation](https://artifacthub.io/docs/topics/annotations/helm/#supported-annotations) for more info. - [Documentation strings](https://github.com/norwoodj/helm-docs#valuesyaml-metadata) have been added to the keys in `values.yaml`.