From fb9b53930effa245d54f3eb94caf8899620ed4e2 Mon Sep 17 00:00:00 2001 From: Martin Milata Date: Wed, 23 Jun 2021 16:11:12 +0200 Subject: [PATCH] docs: allow adding changelog entries without linked issue [skip_ci] --- docs/misc/changelog.md | 11 +++++++---- tools/towncrier.template.md | 2 +- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/misc/changelog.md b/docs/misc/changelog.md index 5e2a647d2..1a0c09a01 100644 --- a/docs/misc/changelog.md +++ b/docs/misc/changelog.md @@ -19,10 +19,13 @@ for different components of the repository: [`towncrier`](https://github.com/twisted/towncrier) aims to create changelogs that are convenient to read, at the expense of being somewhat inconvenient to -create. Furthermore every changelog entry has to be linked to a GitHub issue or -pull request number. If you don't want to create an issue just to satisfy this -rule you can use self-reference to your change's pull request number by first -creating the PR and then adding the entry. +create. + +Furthermore every changelog entry should be linked to a GitHub issue or pull +request number. If you don't want to create an issue just to satisfy this rule +you can use self-reference to your change's pull request number by first +creating the PR and then adding the entry. If this is not suitable, the word +`noissue` can be used in place of the issue number. There are a few types of changelog entries, as described by the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format: diff --git a/tools/towncrier.template.md b/tools/towncrier.template.md index 5b92dda20..38d356a10 100644 --- a/tools/towncrier.template.md +++ b/tools/towncrier.template.md @@ -8,7 +8,7 @@ ### {{ definitions[category]['name'] }} {% if definitions[category]['showcontent'] %} {% for text, values in sections[section][category].items() %} -- {{ text }} {{ values|join(', ') }} +- {{ text }} {{ values|reject("eq", "[#noissue]")|join(', ') }} {% endfor %} {% endif %} {% endfor %}