Use towncrier for changelog generation

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,10 +4,10 @@ Thank you for submitting a PR to pylint!
 To ease the process of reviewing your PR, do make sure to complete the following boxes.
 
 - [ ] Write a good description on what the PR does.
-- [ ] Add an entry to the change log describing the change in
-  `doc/whatsnew/2/2.15/index.rst` (or ``doc/whatsnew/2/2.14/full.rst``
-   if the change needs backporting in 2.14). If necessary you can write
-   details or offer examples on how the new change is supposed to work.
+- [ ] Create a news fragment with `towncrier create <IssueNumber>.<type>` which will be
+  included in the changelog. `<type>` can be one of: new_check, removed_check, extension,
+  false_positive, false_negative, bugfix, other, internal. If necessary you can write
+  details or offer examples on how the new change is supposed to work.
 - [ ] If you used multiple emails or multiple names when contributing, add your mails
       and preferred name in ``script/.contributors_aliases.json``
 -->

.github/workflows/changelog.yml

@@ -0,0 +1,62 @@
+name: changelog
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled, unlabeled, reopened]
+
+env:
+  # Also change CACHE_VERSION in the other workflows
+  CACHE_VERSION: 20
+  DEFAULT_PYTHON: "3.10"
+
+jobs:
+  check-changelog:
+    if: contains(github.event.pull_request.labels.*.name, 'skip news :mute:') != true
+    name: Changelog Entry Check
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check out code from GitHub
+        uses: actions/[email protected]
+        with:
+          # `towncrier check` runs `git diff --name-only origin/main...`, which
+          # needs a non-shallow clone.
+          fetch-depth: 0
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+      - name: Generate partial Python venv restore key
+        id: generate-python-key
+        run: >-
+          echo "::set-output name=key::base-venv-${{ env.CACHE_VERSION }}-${{
+            hashFiles('setup.cfg', 'requirements_test.txt', 'requirements_test_min.txt')
+          }}"
+      - name: Restore Python virtual environment
+        id: cache-venv
+        uses: actions/[email protected]
+        with:
+          path: venv
+          key: >-
+            ${{ runner.os }}-${{ steps.python.outputs.python-version }}-${{
+            steps.generate-python-key.outputs.key }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.python.outputs.python-version }}-base-venv-${{ env.CACHE_VERSION }}-
+      - name: Create Python virtual environment
+        if: steps.cache-venv.outputs.cache-hit != 'true'
+        run: |
+          python -m venv venv
+          . venv/bin/activate
+          python -m pip install -U pip setuptools wheel
+          pip install -U -r requirements_test.txt
+          pip install -U -r doc/requirements.txt
+      - name: Emit warning if news fragment is missing
+        env:
+          BASE_BRANCH: ${{ github.base_ref }}
+        run: |
+          # Fetch the pull request' base branch so towncrier will be able to
+          # compare the current branch with the base branch.
+          git fetch --no-tags origin +refs/heads/${BASE_BRANCH}:refs/remotes/origin/${BASE_BRANCH}
+          . venv/bin/activate
+          towncrier check --compare-with origin/${{ github.base_ref }}

.github/workflows/checks.yaml

@@ -8,7 +8,7 @@ on:
   pull_request: ~
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 20
   DEFAULT_PYTHON: "3.10"
   PRE_COMMIT_CACHE: ~/.cache/pre-commit
 

.github/workflows/primer-test.yaml

@@ -13,7 +13,7 @@ on:
       - ".github/workflows/primer-test.yaml"
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 20
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

.github/workflows/primer_comment.yaml

@@ -13,7 +13,7 @@ on:
       - completed
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 20
 
 permissions:
   contents: read

.github/workflows/primer_run_main.yaml

@@ -15,7 +15,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 20
 
 jobs:
   run-primer:

.github/workflows/primer_run_pr.yaml

@@ -24,7 +24,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 20
 
 jobs:
   run-primer:

.github/workflows/tests.yaml

@@ -10,7 +10,7 @@ on:
       - doc/data/messages/**
 
 env:
-  CACHE_VERSION: 1
+  CACHE_VERSION: 20
 
 jobs:
   tests-linux:

.pre-commit-config.yaml

@@ -85,6 +85,13 @@ repos:
         language: system
         types: [text]
         files: ^(doc/whatsnew/\d+\.\d+\.rst)
+      - id: check-newsfragments
+        name: Check newsfragments
+        entry: python3 -m script.check_newsfragments
+        language: system
+        types: [text]
+        files: ^(doc/whatsnew/fragments)
+        exclude: doc/whatsnew/fragments/_.*.rst
   - repo: https://github.com/rstcheck/rstcheck
     rev: "v6.0.0.post1"
     hooks:

.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

.readthedocs.yaml

@@ -14,3 +14,6 @@ build:
   os: ubuntu-20.04
   tools:
     python: "3.8"
+  jobs:
+    pre_build:
+      - towncrier build --yes --date TBA

doc/conf.py

@@ -131,7 +131,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build", "data/**"]
+exclude_patterns = ["_build", "data/**", "whatsnew/fragments"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None

doc/development_guide/contributor_guide/contribute.rst

@@ -59,11 +59,17 @@ your patch gets accepted:
 
 - We recommend using Python 3.8 or higher for development of Pylint as it gives
   you access to the latest ``ast`` parser.
+
 - Install the dev dependencies, see :ref:`contributor_install`.
+
 - Use our test suite and write new tests, see :ref:`contributor_testing`.
-- Add an entry to the change log describing the change in `doc/whatsnew/2/2.15/index.rst`
-  (or ``doc/whatsnew/2/2.14/full.rst`` if the change needs backporting in 2.14).
-  If necessary you can write details or offer examples on how the new change is supposed to work.
+
+.. keep this in sync with the description of PULL_REQUEST_TEMPLATE.md!
+
+- Create a news fragment with `towncrier create <IssueNumber>.<type>` which will be
+  included in the changelog. `<type>` can be one of: new_check, removed_check, extension,
+  false_positive, false_negative, bugfix, other, internal. If necessary you can write
+  details or offer examples on how the new change is supposed to work.
 
 - Document your change, if it is a non-trivial one.
 

doc/requirements.txt

@@ -1,5 +1,6 @@
 Sphinx==5.0.2
 sphinx-reredirects<1
 myst-parser~=0.18
+towncrier~=21.9
 furo==2022.6.21
 -e .

doc/whatsnew/2/2.15/index.rst

@@ -14,93 +14,4 @@ Summary -- Release highlights
 * We improved ``pylint``'s handling of namespace packages. More packages should be
   linted without resorting to using the ``-recursive=y`` option.
 
-
-New checkers
-============
-
-Added new checker ``missing-timeout`` to warn of default timeout values that could cause
-a program to be hanging indefinitely.
-
-
-Removed checkers
-================
-
-
-Extensions
-==========
-
-
-False positives fixed
-=====================
-
-* Don't report ``unsupported-binary-operation`` on Python <= 3.9 when using the ``|`` operator
-  with types, if one has a metaclass that overloads ``__or__`` or ``__ror__`` as appropriate.
-
-  Closes #4951
-
-False negatives fixed
-=====================
-
-* Emit ``modified-iterating-list`` and analogous messages for dicts and sets when iterating
-  literals, or when using the ``del`` keyword.
-
-  Closes #6648
-
-* Emit ``using-constant-test`` when testing the truth value of a variable or call result
-  holding a generator.
-
-  Closes #6909
-
-* Emit ``used-before-assignment`` for self-referencing named expressions (``:=``) lacking
-  prior assignments.
-
-  Closes #5653
-
-* Emit ``used-before-assignment`` when calling nested functions before assignment.
-
-  Closes #6812
-
-* Emit ``used-before-assignment`` when relying on a name that is reimported later in a function.
-
-  Closes #4624
-
-* Emit ``used-before-assignment`` for self-referencing assignments under if conditions.
-
-  Closes #6643
-
-* Emit ``nonlocal-without-binding`` when a nonlocal name has been assigned at a later point in the same scope.
-
-  Closes #6883
-
-* Rename ``unhashable-dict-key`` to ``unhashable-member`` and emit when creating sets and dicts,
-  not just when accessing dicts.
-
-  Closes #7034, Closes #7055
-
-
-Other bug fixes
-===============
-
-
-Other Changes
-=============
-
-* ``useless-super-delegation`` has been renamed to ``useless-parent-delegation`` in order to be more generic.
-
-  Closes #6953
-
-* Update ``astroid`` to 2.12.
-
-
-Internal changes
-================
-
-* ``pylint.testutils.primer`` is now a private API.
-
-  Refs #6905
-
-* Fixed an issue where it was impossible to update functional tests output when the existing
-  output was impossible to parse. Instead of raising an error we raise a warning message and
-  let the functional test fail with a default value.
-
-  Refs #6891
+.. towncrier release notes start

doc/whatsnew/fragments/4624.false_negative

@@ -0,0 +1,3 @@
+Emit ``used-before-assignment`` when relying on a name that is reimported later in a function.
+
+Closes #4624

doc/whatsnew/fragments/4951.false_positive

@@ -0,0 +1,4 @@
+Don't report ``unsupported-binary-operation`` on Python <= 3.9 when using the ``|`` operator
+with types, if one has a metaclass that overloads ``__or__`` or ``__ror__`` as appropriate.
+
+Closes #4951

doc/whatsnew/fragments/5653.false_negative

@@ -0,0 +1,4 @@
+Emit ``used-before-assignment`` for self-referencing named expressions (``:=``) lacking
+prior assignments.
+
+Closes #5653

doc/whatsnew/fragments/6643.false_negative

@@ -0,0 +1,3 @@
+Emit ``used-before-assignment`` for self-referencing assignments under if conditions.
+
+Closes #6643

doc/whatsnew/fragments/6648.false_negative

@@ -0,0 +1,4 @@
+Emit ``modified-iterating-list`` and analogous messages for dicts and sets when iterating
+literals, or when using the ``del`` keyword.
+
+Closes #6648

doc/whatsnew/fragments/6780.new_check

@@ -0,0 +1,4 @@
+Added new checker ``missing-timeout`` to warn of default timeout values that could cause
+a program to be hanging indefinitely.
+
+Refs #6780

doc/whatsnew/fragments/6812.false_negative

@@ -0,0 +1,3 @@
+Emit ``used-before-assignment`` when calling nested functions before assignment.
+
+Closes #6812

doc/whatsnew/fragments/6883.false_negative

@@ -0,0 +1,4 @@
+
+Emit ``nonlocal-without-binding`` when a nonlocal name has been assigned at a later point in the same scope.
+
+Closes #6883

doc/whatsnew/fragments/6891.internal

@@ -0,0 +1,5 @@
+Fixed an issue where it was impossible to update functional tests output when the existing
+output was impossible to parse. Instead of raising an error we raise a warning message and
+let the functional test fail with a default value.
+
+Refs #6891

doc/whatsnew/fragments/6905.internal

@@ -0,0 +1,3 @@
+``pylint.testutils.primer`` is now a private API.
+
+Refs #6905

doc/whatsnew/fragments/6909.false_negative

@@ -0,0 +1,4 @@
+Emit ``using-constant-test`` when testing the truth value of a variable or call result
+holding a generator.
+
+Closes #6909

doc/whatsnew/fragments/6953.other

@@ -0,0 +1,3 @@
+``useless-super-delegation`` has been renamed to ``useless-parent-delegation`` in order to be more generic.
+
+Closes #6953

doc/whatsnew/fragments/6974.other

@@ -0,0 +1,3 @@
+Pylint now uses ``towncrier`` for changelog generation.
+
+Refs #6974

doc/whatsnew/fragments/7034.false_negative

@@ -0,0 +1,5 @@
+
+Rename ``unhashable-dict-key`` to ``unhashable-member`` and emit when creating sets and dicts,
+not just when accessing dicts.
+
+Closes #7034, Closes #7055

doc/whatsnew/fragments/7153.other

@@ -0,0 +1,3 @@
+Update ``astroid`` to 2.12.
+
+Refs #7153