Merge branch 'trunk' into debt/encoding-warning

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - uses: hynek/build-and-inspect-python-package@54d50a852d960c25f25f7f1874d3d969ecbe4eb0
+    - uses: hynek/build-and-inspect-python-package@f51d0e79a34e62af977fcfe458b41fa8490e6e65
 
     - name: Set up ${{ matrix.python.name }}
       uses: actions/setup-python@v4

.pre-commit-config.yaml

@@ -4,12 +4,12 @@ ci:
 
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.1.1
+    rev: 24.3.0
     hooks:
       - id: black
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
         args: [--py38-plus]

docs/cli.rst

@@ -79,6 +79,13 @@ If the fragments directory does not exist, it will be created.
 If the filename exists already, ``towncrier create`` will add (and then increment) a number after the fragment type until it finds a filename that does not exist yet.
 In the above example, it will generate ``123.bugfix.1.rst`` if ``123.bugfix.rst`` already exists.
 
+To create a news fragment not tied to a specific issue (which towncrier calls an "orphan fragment"), start the fragment name with a ``+``.
+If that is the entire fragment name, a random hash will be added for you::
+
+   $ towncrier create +.feature.rst
+   $ ls newsfragments/
+   +fcc4dc7b.feature.rst
+
 .. option:: --content, -c CONTENT
 
    A string to use for content.

docs/tutorial.rst

@@ -15,10 +15,13 @@ Configuration
 ``towncrier`` keeps its config in the `PEP-518 <https://www.python.org/dev/peps/pep-0518/>`_ ``pyproject.toml`` or a ``towncrier.toml`` file.
 If the latter exists, it takes precedence.
 
-The most basic configuration is just telling ``towncrier`` where to look for news fragments::
+The most basic configuration is just telling ``towncrier`` where to look for news fragments and what file to generate::
 
    [tool.towncrier]
    directory = "changes"
+   # Where you want your news files to come out, `NEWS.rst` is the default.
+   # This can be .rst or .md, towncrier's default template works with both.
+   # filename = "NEWS.rst"
 
 Which will look into "./changes" for news fragments and write them into "./NEWS.rst".
 
@@ -32,9 +35,6 @@ If you're working on a Python project, you can also specify a package::
    # but if you don't keep your code in a 'src' dir, remove the
    # config option
    package_dir = "src"
-   # Where you want your news files to come out. This can be .rst
-   # or .md, towncrier's default template works with both.
-   filename = "NEWS.rst"
 
 By default, ``towncrier`` will look for news fragments inside your Python package, in a directory named ``newsfragments``.
 With this example project, it will look in ``src/myproject/newsfragments/`` for them.

noxfile.py

@@ -20,6 +20,7 @@ def pre_commit(session: nox.Session) -> None:
 # Keep list in-sync with ci.yml/test-linux & pyproject.toml
 @nox.session(python=["pypy3.8", "3.8", "3.9", "3.10", "3.11", "3.12"])
 def tests(session: nox.Session) -> None:
+    session.env["PYTHONWARNDEFAULTENCODING"] = "1"
     session.install("Twisted", "coverage[toml]")
     posargs = list(session.posargs)
 

src/towncrier/_builder.py

@@ -13,15 +13,6 @@
 from jinja2 import Template
 
 
-def strip_if_integer_string(s: str) -> str:
-    try:
-        i = int(s)
-    except ValueError:
-        return s
-
-    return str(i)
-
-
 # Returns ticket, category and counter or (None, None, None) if the basename
 # could not be parsed or doesn't contain a valid category.
 def parse_newfragment_basename(
@@ -45,7 +36,11 @@ def parse_newfragment_basename(
             # NOTE: This allows news fragment names like fix-1.2.3.feature or
             # something-cool.feature.ext for projects that don't use ticket
             # numbers in news fragment names.
-            ticket = strip_if_integer_string(".".join(parts[0:i]))
+            ticket = ".".join(parts[0:i]).strip()
+            # If the ticket is an integer, remove any leading zeros (to resolve
+            # issue #126).
+            if ticket.isdigit():
+                ticket = str(int(ticket))
             counter = 0
             # Use the following part as the counter if it exists and is a valid
             # digit.

src/towncrier/create.py

@@ -64,6 +64,9 @@ def _main(
     * .doc - a documentation improvement,
     * .removal - a deprecation or removal of public API,
     * .misc - a ticket has been closed, but it is not of interest to users.
+
+    If the FILENAME base is just '+' (to create a fragment not tied to an
+    issue), it will be appended with a random hex string.
     """
     __main(ctx, directory, config, filename, edit, content)
 

src/towncrier/newsfragments/561.misc.rst

@@ -0,0 +1 @@
+Enable reporting of EncodingWarnings when running tests.

src/towncrier/newsfragments/586.doc

@@ -0,0 +1 @@
+The tutorial now introduces the `filename` option in the appropriate paragraph and mentions its default value.

src/towncrier/newsfragments/587.bugfix

@@ -0,0 +1 @@
+The default Markdown template now renders a title containing the release version and date, even when the `name` configuration is left empty.

src/towncrier/newsfragments/588.bugfix

@@ -0,0 +1 @@
+Orphan news fragments, fragments not associated with an issue, consisting of only digits (e.g. '+12345678.feature') now retain their leading marker character.

src/towncrier/newsfragments/589.doc

@@ -0,0 +1 @@
+Add docs to explain how ``towncrier create +.feature.rst`` (orphan fragments) works.

src/towncrier/templates/default.md

@@ -2,7 +2,7 @@
 {% if versiondata.name %}
 # {{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
 {% else %}
-{{ versiondata.version }} ({{ versiondata.date }})
+# {{ versiondata.version }} ({{ versiondata.date }})
 {% endif %}
 {% endif %}
 {% for section, _ in sections.items() %}

src/towncrier/test/test_build.py

@@ -1248,6 +1248,53 @@ def test_default_start_string_markdown(self, runner):
 
         self.assertEqual(expected_output, output)
 
+    @with_project(
+        config="""
+        [tool.towncrier]
+        name = ""
+        directory = "changes"
+        filename = "NEWS.md"
+        version = "1.2.3"
+        """
+    )
+    def test_markdown_no_name_title(self, runner):
+        """
+        When configured with an empty `name` option,
+        the default template used for Markdown
+        renders the title of the release note with just
+        the version number and release date.
+        """
+        write("changes/123.feature", "Adds levitation")
+        write(
+            "NEWS.md",
+            contents="""
+                A line
+
+                <!-- towncrier release notes start -->
+            """,
+            dedent=True,
+        )
+
+        result = runner.invoke(_main, ["--date", "01-01-2001"], catch_exceptions=False)
+        self.assertEqual(0, result.exit_code, result.output)
+        output = read("NEWS.md")
+
+        expected_output = dedent(
+            """
+            A line
+
+            <!-- towncrier release notes start -->
+
+            # 1.2.3 (01-01-2001)
+
+            ### Features
+
+            - Adds levitation (#123)
+            """
+        )
+
+        self.assertEqual(expected_output, output)
+
     @with_project(
         config="""
         [tool.towncrier]

src/towncrier/test/test_builder.py

@@ -125,3 +125,10 @@ def test_orphan_with_dotted_number(self):
             parse_newfragment_basename("+orphan_12.3.feature", ["feature"]),
             ("+orphan_12.3", "feature", 0),
         )
+
+    def test_orphan_all_digits(self):
+        """Orphaned snippets can consist of only digits."""
+        self.assertEqual(
+            parse_newfragment_basename("+123.feature", ["feature"]),
+            ("+123", "feature", 0),
+        )