From c9252a122256eaa491da5a2f4141ce1a580824ee Mon Sep 17 00:00:00 2001 From: jason plumb <75337021+breedx-splk@users.noreply.github.com> Date: Tue, 6 Feb 2024 02:10:36 -0800 Subject: [PATCH] A few small documentation things around changelog generation. (#691) Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com> --- .chloggen/TEMPLATE.yaml | 1 + CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.chloggen/TEMPLATE.yaml b/.chloggen/TEMPLATE.yaml index 4387154dd..b094f4d18 100644 --- a/.chloggen/TEMPLATE.yaml +++ b/.chloggen/TEMPLATE.yaml @@ -13,6 +13,7 @@ component: note: # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. issues: [] # (Optional) One or more lines of additional information to render under the primary note. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abde6789c..0639de51d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -174,7 +174,7 @@ from `.yaml` files in the [/.chloggen](/.chloggen) directory. Your pull request should add a new `.yaml` file to this directory. The name of your file can be arbitrary but must be unique since the last release. -During the release process, all `./chloggen/*.yaml` files are transcribed into +During the release process, all `./.chloggen/*.yaml` files are transcribed into `CHANGELOG.md` and then deleted. 1. Create an entry file using `make chlog-new`. The command generates a new file,