Merge branch 'trunk' into fix-md-section-depth

Author: adiroiban

.github/workflows/ci.yml

@@ -34,7 +34,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - uses: hynek/build-and-inspect-python-package@f51d0e79a34e62af977fcfe458b41fa8490e6e65
+    - uses: hynek/build-and-inspect-python-package@b5076c307dc91924a82ad150cdd1533b444d3310  # v2.12.0
 
     - name: Set up ${{ matrix.python.name }}
       uses: actions/setup-python@v4
@@ -49,7 +49,7 @@ jobs:
     - run: nox -e ${{ matrix.task.nox }}
 
     - name: Publish
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: dist
         path: dist/
@@ -84,7 +84,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Download package files
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: dist
         path: dist/
@@ -104,10 +104,11 @@ jobs:
     - run: nox --python ${{ matrix.python.action }} -e ${{ matrix.task.nox }} -- --use-wheel dist/*.whl
 
     - name: Upload coverage data
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: coverage-data
+        name: coverage-data-${{ matrix.python.action }}
         path: .coverage.*
+        include-hidden-files: true
         if-no-files-found: ignore
 
 
@@ -130,7 +131,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Download package files
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: dist
         path: dist/
@@ -177,7 +178,7 @@ jobs:
         fetch-depth: 0
 
     - name: Download package files
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: dist
         path: dist/
@@ -245,7 +246,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Download package files
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
       with:
         name: dist
         path: dist/
@@ -282,9 +283,11 @@ jobs:
 
     - run: python -Im pip install --upgrade coverage[toml]
 
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
-        name: coverage-data
+        pattern: coverage-data-*
+        merge-multiple: true
+        path: .
 
     - name: Combine coverage & fail if it's <100%.
       run: |
@@ -298,10 +301,11 @@ jobs:
         python -Im coverage report --fail-under=100
 
     - name: Upload HTML report if check failed.
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: html-report
         path: htmlcov
+        include-hidden-files: true
       if: ${{ failure() }}
 
   # This is a meta-job to simplify PR CI enforcement configuration in GitHub.

.pre-commit-config.yaml

@@ -4,29 +4,29 @@ ci:
 
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.8.0
+    rev: 25.1.0
     hooks:
       - id: black
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.17.0
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+    rev: 6.0.1
     hooks:
       - id: isort
         additional_dependencies: [toml]
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.1
+    rev: 7.1.2
     hooks:
     - id: flake8
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -35,6 +35,6 @@ repos:
       - id: check-yaml
 
   - repo: https://github.com/twisted/towncrier
-    rev: 24.7.1
+    rev: 24.8.0
     hooks:
       - id: towncrier-check

.readthedocs.yaml

@@ -3,6 +3,7 @@ version: 2
 sphinx:
   # We want to fail as this is also our CI check for the docs.
   fail_on_warning: True
+  configuration: docs/conf.py
 
 # We don't need PDF and epub for the docs.
 formats: []

NEWS.rst

@@ -5,6 +5,43 @@ Release notes
 
 .. towncrier release notes start
 
+Towncrier 24.8.0 (2024-08-23)
+=============================
+
+No changes since the previous release candidate.
+
+
+Features
+--------
+
+- Add ``.gitkeep`` as an ignored filename. (`#643 <https://github.com/twisted/towncrier/issues/643>`_)
+- Config `ignore` option now supports wildcard matching via `fnmatch <https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch>`_. (`#644 <https://github.com/twisted/towncrier/issues/644>`_)
+- Add a config for enforcing issue names using regex. (`#649 <https://github.com/twisted/towncrier/issues/649>`_)
+
+
+Bugfixes
+--------
+
+- The template file is now ignored based only on the file name. (`#638 <https://github.com/twisted/towncrier/issues/638>`_)
+- Control of the header formatting is once again completely up to the user when they are writing markdown files (fixes a regression introduced in [#610](https://github.com/twisted/towncrier/pull/610)). (`#651 <https://github.com/twisted/towncrier/issues/651>`_)
+- Fixed an issue where `issue_template` failed recognizing the issue name of files with a non-category suffix (`.md`) (`#654 <https://github.com/twisted/towncrier/issues/654>`_)
+- Fixed a bug where orphan news fragments (e.g. +abc1234.feature) would fail when an `issue_pattern` is configured. Orphan news fragments are now excempt from `issue_pattern` checks. (`#655 <https://github.com/twisted/towncrier/issues/655>`_)
+
+
+Deprecations and Removals
+-------------------------
+
+- Moved towncrier version definition from src/towncrier/_version.py to pyproject.toml
+
+  towncrier.__version__ was removed, after being deprecated in 23.6.0. (`#640 <https://github.com/twisted/towncrier/issues/640>`_)
+
+
+Misc
+----
+
+- `#640 <https://github.com/twisted/towncrier/issues/640>`_, `#657 <https://github.com/twisted/towncrier/issues/657>`_
+
+
 Towncrier 24.7.1 (2024-07-31)
 =============================
 

RELEASE.rst

@@ -23,7 +23,12 @@ In ``pyproject.toml`` the version is set using a PEP440 compliant string:
 
     version = "19.9.0rc1"
 
-Run ``venv/bin/towncrier build --yes`` to generate the news release NEWS file.
+Use `towncrier` to generate the news release NEWS file, but first,
+make sure the new version is installed::
+
+    venv/bin/pip install -e .
+    venv/bin/towncrier build --yes
+
 Commit and push to the primary repository, not a fork.
 It is important to not use a fork so that pushed tags end up in the primary repository,
 server provided secrets for publishing to PyPI are available, and maybe more.

docs/cli.rst

@@ -121,3 +121,10 @@ By default, ``towncrier`` compares the current branch against ``origin/main`` (a
    Use ``REMOTE-BRANCH`` instead of ``origin/main``::
 
       $ towncrier check --compare-with origin/trunk
+
+.. option:: --staged
+
+   Include files that have been staged for commit when checking for news fragments::
+
+      $ towncrier check --staged
+      $ towncrier check --staged --compare-with origin/trunk

docs/configuration.rst

@@ -17,9 +17,8 @@ A minimal configuration for a Python project looks like this:
 .. code-block:: toml
 
    # pyproject.toml
-
-   [tool.towncrier]
-   package = "myproject"
+   [project]
+   name = "myproject"
 
 A minimal configuration for a non-Python project looks like this:
 
@@ -36,9 +35,9 @@ Top level keys
 ``name``
     The name of your project.
 
-    For Python projects that provide a ``package`` key, if left empty then the name will be automatically determined.
+    For Python projects that provide a ``package`` key, if left empty then the name will be automatically determined from the ``package`` key.
 
-    ``""`` by default.
+    Defaults to the key ``[project.name]`` in ``pyproject.toml`` (if present), otherwise defaults to the empty string ``""``.
 
 ``version``
     The version of your project.
@@ -167,6 +166,8 @@ Extra top level keys for Python projects
     Allows ``name`` and ``version`` to be automatically determined from the Python package.
     Changes the default ``directory`` to be a ``newsfragments`` directory within this package.
 
+    Defaults to the key ``[project.name]`` in ``pyproject.toml`` (if present), otherwise defaults to the empty string ``""``.
+
 ``package_dir``
     The folder your package lives.
 

noxfile.py

@@ -89,7 +89,7 @@ def docs(session: nox.Session) -> None:
 
 @nox.session
 def build(session: nox.Session) -> None:
-    session.install("build", "twine")
+    session.install("build", "twine", "pkginfo>=1.12.0")
 
     # If no argument is passed, build builds an sdist and then a wheel from
     # that sdist.

pyproject.toml

@@ -9,7 +9,7 @@ name = "towncrier"
 # For RC    - 23.11.0rc1  (release candidate starts at 1)
 # For final - 23.11.0
 # make sure to follow PEP440
-version = "24.7.2.dev0"
+version = "24.8.0.dev0"
 description = "Building newsfiles for your project."
 readme = "README.rst"
 license = "MIT"
@@ -63,7 +63,10 @@ Distribution = "https://pypi.org/project/towncrier"
 exclude = [
     "admin",
     "bin",
-    "docs",
+    ".github",
+    ".git-blame-ignore-revs",
+    ".pre-commit-config.yaml",
+    ".pre-commit-hooks.yaml",
     ".readthedocs.yaml",
     "src/towncrier/newsfragments",
 ]

src/towncrier/_builder.py

@@ -328,6 +328,29 @@ def render_issue(issue_format: str | None, issue: str) -> str:
         return issue_format.format(issue=issue)
 
 
+def append_newlines_if_trailing_code_block(text: str) -> str:
+    """
+    Appends two newlines to a text string if it ends with a code block.
+
+    Used by `render_fragments` to avoid appending link to issue number into the code block.
+    """
+    # Search for the existence of a code block at the end. We do this by searching for:
+    # 1. start of code block: two ":", followed by two newlines
+    # 2. any number of indented, or empty, lines (or the code block would end)
+    # 3. one line of indented text w/o a trailing newline (because the string is stripped)
+    # 4. end of the string.
+    indented_text = r"  [ \t]+[^\n]*"
+    empty_or_indented_text_lines = f"(({indented_text})?\n)*"
+    regex = r"::\n\n" + empty_or_indented_text_lines + indented_text + "$"
+    if re.search(regex, text):
+        # We insert one space, the default template inserts another, which results
+        # in the correct indentation given default bullet indentation.
+        # Non-default templates with different indentation will likely encounter issues
+        # if they have trailing code blocks.
+        return text + "\n\n "
+    return text
+
+
 def render_fragments(
     template: str,
     issue_format: str | None,
@@ -381,6 +404,7 @@ def render_fragments(
             # for the template, after formatting each issue number
             categories = {}
             for text, issues in entries:
+                text = append_newlines_if_trailing_code_block(text)
                 rendered = [render_issue(issue_format, i) for i in issues]
                 categories[text] = rendered