diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a73ae05c..550826d7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -265,8 +265,7 @@ jobs: python -I admin/check_tag_version_match.py "${{ github.ref }}" - name: Publish to PyPI - on tag - # This was tag 1.9.0 on 2024-07-30 - uses: pypa/gh-action-pypi-publish@ec4db0b4ddc65acdf4bff5fa45ac92d78b56bdf0 + uses: pypa/gh-action-pypi-publish@release/v1 coverage: diff --git a/NEWS.rst b/NEWS.rst index 67f54a94..58b9c88e 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -5,6 +5,55 @@ Release notes .. towncrier release notes start +towncrier 25.8.0 (2025-08-30) +============================= + +No significant changes since the previous release candidate. + + +Features +-------- + +- Support was added for Mercurial SCM. (`#394 `_) +- The :command:`towncrier check` command now has a ``--staged`` flag to inspect the files staged for commit when checking for a news fragment: useful in a pre-commit hook (`#676 `_) +- When used with an :file:`pyproject.toml` file, when no explicit values are + defined for ``[tool.towncrier.name|package]`` they will now fallback to + the value of ``[project.name]``. (`#687 `_) +- The ``directory`` configuration option is no longer required. + It can now be generated based on value from the ``name`` configuration. + (`#691 `_) +- Added support for Python 3.13 and removed support for Python 3.8. (`#700 `_) + + +Bugfixes +-------- + +- Multi-line news fragments that end with a code block will now have a newline inserted before appending the link to the issue, to avoid breaking formatting. (`#614 `_) +- Markdown header level is correctly inferred from ``title_format``. (`#695 `_) + + +Improved Documentation +---------------------- + +- The documentation RST source files are now included in the sdist package. (`#672 `_) +- Refactor the default markdown template to make it easier to understand, extend, and customize. (`#706 `_) + + +Deprecations and Removals +------------------------- + +- Support for Python 3.8 was removed. (`#700 `_) +- When no sections are present, + the default Markdown template now renders the category headers as H2. + In previous versions it was rendered as H3. (`#663 `_) + + +Misc +---- + +- `#667 `_, `#669 `_, `#679 `_, `#680 `_, `#682 `_, `#701 `_, `#702 `_, `#713 `_ + + Towncrier 24.8.0 (2024-08-23) ============================= diff --git a/pyproject.toml b/pyproject.toml index 34acd481..f39dd740 100644 --- a/pyproject.toml +++ b/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.8.0.dev0" +version = "25.8.0.dev0" description = "Building newsfiles for your project." readme = "README.rst" license = "MIT" diff --git a/src/towncrier/newsfragments/394.feature.rst b/src/towncrier/newsfragments/394.feature.rst deleted file mode 100644 index 487857fc..00000000 --- a/src/towncrier/newsfragments/394.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Support was added for Mercurial SCM. diff --git a/src/towncrier/newsfragments/614.bugfix.rst b/src/towncrier/newsfragments/614.bugfix.rst deleted file mode 100644 index f8b12a6e..00000000 --- a/src/towncrier/newsfragments/614.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Multi-line newsfragments that ends with a code block will now have a newline inserted before appending the link to the issue, to avoid breaking formatting. diff --git a/src/towncrier/newsfragments/663.removal b/src/towncrier/newsfragments/663.removal deleted file mode 100644 index 504028ff..00000000 --- a/src/towncrier/newsfragments/663.removal +++ /dev/null @@ -1,3 +0,0 @@ -When no sections are present, -the default Markdown template now renders the category headers as H2. -In previous versions it was rendered as H3. diff --git a/src/towncrier/newsfragments/667.misc.rst b/src/towncrier/newsfragments/667.misc.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/src/towncrier/newsfragments/669.misc.rst b/src/towncrier/newsfragments/669.misc.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/src/towncrier/newsfragments/672.doc b/src/towncrier/newsfragments/672.doc deleted file mode 100644 index d1aa14b0..00000000 --- a/src/towncrier/newsfragments/672.doc +++ /dev/null @@ -1 +0,0 @@ -The documentation RST source files are now included in the sdist package. diff --git a/src/towncrier/newsfragments/676.feature.rst b/src/towncrier/newsfragments/676.feature.rst deleted file mode 100644 index a0e0cfff..00000000 --- a/src/towncrier/newsfragments/676.feature.rst +++ /dev/null @@ -1 +0,0 @@ -The `towncrier check` command now has a `--staged` flag to inspect the files staged for commit when checking for a news fragment: useful in a pre-commit hook diff --git a/src/towncrier/newsfragments/679.misc.rst b/src/towncrier/newsfragments/679.misc.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/src/towncrier/newsfragments/680.misc b/src/towncrier/newsfragments/680.misc deleted file mode 100644 index e69de29b..00000000 diff --git a/src/towncrier/newsfragments/682.misc.rst b/src/towncrier/newsfragments/682.misc.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/src/towncrier/newsfragments/687.feature.rst b/src/towncrier/newsfragments/687.feature.rst deleted file mode 100644 index 42d67ec8..00000000 --- a/src/towncrier/newsfragments/687.feature.rst +++ /dev/null @@ -1,3 +0,0 @@ -When used with an `pyproject.toml` file, when no explicit values are -defined for [tool.towncrier.name|package] they will now fallback to -the value of [project.name]. diff --git a/src/towncrier/newsfragments/691.feature.rst b/src/towncrier/newsfragments/691.feature.rst deleted file mode 100644 index 1b42de5a..00000000 --- a/src/towncrier/newsfragments/691.feature.rst +++ /dev/null @@ -1 +0,0 @@ -More simple configuration for Keep a Changelog style changelogs diff --git a/src/towncrier/newsfragments/695.bugfix.rst b/src/towncrier/newsfragments/695.bugfix.rst deleted file mode 100644 index 9388e320..00000000 --- a/src/towncrier/newsfragments/695.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Markdown header level is correctly inferred from ``title_format``. diff --git a/src/towncrier/newsfragments/700.feature.rst b/src/towncrier/newsfragments/700.feature.rst deleted file mode 100644 index 3ae20e80..00000000 --- a/src/towncrier/newsfragments/700.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added support for Python 3.13 and removed support for Python 3.8. diff --git a/src/towncrier/newsfragments/701.misc.rst b/src/towncrier/newsfragments/701.misc.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/src/towncrier/newsfragments/702.misc.rst b/src/towncrier/newsfragments/702.misc.rst deleted file mode 100644 index c71be643..00000000 --- a/src/towncrier/newsfragments/702.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Skip the mercurial tests if not found on the local system. diff --git a/src/towncrier/newsfragments/706.doc b/src/towncrier/newsfragments/706.doc deleted file mode 100644 index ca18a036..00000000 --- a/src/towncrier/newsfragments/706.doc +++ /dev/null @@ -1 +0,0 @@ -Refactor the default markdown template to make it easier to understand, extend, and customize. diff --git a/src/towncrier/newsfragments/713.misc.rst b/src/towncrier/newsfragments/713.misc.rst deleted file mode 100644 index e69de29b..00000000