docs: allow adding changelog entries without linked issue

[skip_ci]
pull/1581/head
Martin Milata 3 years ago
parent 10d72b964f
commit fb9b53930e

@ -19,10 +19,13 @@ for different components of the repository:
[`towncrier`](https://github.com/twisted/towncrier) aims to create changelogs [`towncrier`](https://github.com/twisted/towncrier) aims to create changelogs
that are convenient to read, at the expense of being somewhat inconvenient to 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 create.
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 Furthermore every changelog entry should be linked to a GitHub issue or pull
creating the PR and then adding the entry. 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 There are a few types of changelog entries, as described by the [Keep a
Changelog](https://keepachangelog.com/en/1.0.0/) format: Changelog](https://keepachangelog.com/en/1.0.0/) format:

@ -8,7 +8,7 @@
### {{ definitions[category]['name'] }} ### {{ definitions[category]['name'] }}
{% if definitions[category]['showcontent'] %} {% if definitions[category]['showcontent'] %}
{% for text, values in sections[section][category].items() %} {% for text, values in sections[section][category].items() %}
- {{ text }} {{ values|join(', ') }} - {{ text }} {{ values|reject("eq", "[#noissue]")|join(', ') }}
{% endfor %} {% endfor %}
{% endif %} {% endif %}
{% endfor %} {% endfor %}

Loading…
Cancel
Save