summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDudeNr33 <3929834+DudeNr33@users.noreply.github.com>2022-07-17 17:27:45 +0200
committerAndreas Finkler <3929834+DudeNr33@users.noreply.github.com>2022-07-17 18:13:46 +0200
commit36f14989694c64a3fdf7b6f7b44acff3639ad773 (patch)
tree08b9e6caf577efcb53c91bb3831bc6d79a5ebaf5
parent9c7f122c615f118723b696956436e54c8b27e62d (diff)
downloadpylint-git-36f14989694c64a3fdf7b6f7b44acff3639ad773.tar.gz
Add configuration for `towncrier`
-rw-r--r--.pyenchant_pylint_custom_dict.txt2
-rw-r--r--doc/whatsnew/fragments/_template.rst38
-rw-r--r--towncrier.toml50
3 files changed, 90 insertions, 0 deletions
diff --git a/.pyenchant_pylint_custom_dict.txt b/.pyenchant_pylint_custom_dict.txt
index c827856b5..f37c3ad63 100644
--- a/.pyenchant_pylint_custom_dict.txt
+++ b/.pyenchant_pylint_custom_dict.txt
@@ -212,6 +212,7 @@ mymodule
mypy
namedtuple
namespace
+newsfile
newstyle
nl
nodename
@@ -320,6 +321,7 @@ tokenizer
toml
tomlkit
toplevel
+towncrier
tp
truthness
tryexcept
diff --git a/doc/whatsnew/fragments/_template.rst b/doc/whatsnew/fragments/_template.rst
new file mode 100644
index 000000000..115dc5766
--- /dev/null
+++ b/doc/whatsnew/fragments/_template.rst
@@ -0,0 +1,38 @@
+{% set title = "What's new in Pylint " + versiondata.version + "?" %}
+{{ title }}
+{{ underlines[0] * (title|length) }}
+Release date: {{ versiondata.date }}
+
+{% for section, _ in sections.items() %}
+{% set underline = underlines[0] %}{% if section %}{{section}}
+{{ underline * section|length }}{% set underline = underlines[1] %}
+
+{% endif %}
+
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section]%}
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }} ({{ values|join(', ') }})
+{% endfor %}
+
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% if sections[section][category]|length == 0 %}
+No significant changes.
+
+{% else %}
+{% endif %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}
+{% endfor %}
diff --git a/towncrier.toml b/towncrier.toml
new file mode 100644
index 000000000..52b4072b3
--- /dev/null
+++ b/towncrier.toml
@@ -0,0 +1,50 @@
+[tool.towncrier]
+version = "2.15.0"
+directory = "doc/whatsnew/fragments"
+filename = "doc/whatsnew/2/2.15/index.rst"
+template = "doc/whatsnew/fragments/_template.rst"
+issue_format = "`#{issue} <https://github.com/PyCQA/pylint/issues/{issue}>`_"
+
+# Definition of fragment types.
+# TODO: with the next towncrier release (21.9.1) it will be possible to define
+# custom types as toml tables:
+# https://github.com/twisted/towncrier#further-options
+[[tool.towncrier.type]]
+directory = "new_check"
+name = "New Checks"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removed_check"
+name = "Removed Checks"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "extension"
+name = "Extensions"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "false_positive"
+name = "False Positives Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "false_negative"
+name = "False Negatives Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Other Bug Fixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "other"
+name = "Other Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "internal"
+name = "Internal Changes"
+showcontent = true