Release 24.7.0 (#628)

twisted · Jul 31, 2024 · 4ec2a29 · 4ec2a29
2 parents 67c9fd2 + fbb4cea
commit 4ec2a29
Show file tree

Hide file tree

Showing 36 changed files with 93 additions and 51 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,12 +1,16 @@
 # Description
+
+Fixes #<!-- add the associated GitHub Issue ID>
+
 <!-- add a short summary if necessary; mention issue numbers -->
 
+
 # Checklist
 <!-- add a "X" inside the brackets to confirm -->
 * [ ] Make sure changes are covered by existing or new tests.
-* [ ] For at least one Python version, make sure local test run is green.
-* [ ] Create a file in `src/towncrier/newsfragments/`. Describe your
- change and include important information. Your change will be included in the public release notes.
+* [ ] For at least one Python version, make sure test pass on your local environment.
+* [ ] Create a file in `src/towncrier/newsfragments/`. Briefly describe your
+ changes, with information useful to end users. Your change will be included in the public release notes.
 * [ ] Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
 * [ ] Ensure `docs/tutorial.rst` is still up-to-date.
 * [ ] If you add new **CLI arguments** (or change the meaning of existing ones), make sure `docs/cli.rst` reflects those changes.

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -159,8 +159,8 @@ jobs:
  python:
  # Use a recent version to avoid having common disconnects between
  # local development setups and CI.
- - name: CPython 3.11
- python-version: '3.11'
+ - name: CPython 3.12
+ python-version: '3.12'
  task:
  - name: Check Newsfragment
  run: |
@@ -264,7 +264,8 @@ jobs:
  python -I admin/check_tag_version_match.py "${{ github.ref }}"
 
  - name: Publish to PyPI - on tag
- uses: pypa/gh-action-pypi-publish@a56da0b891b3dc519c7ee3284aff1fad93cc8598
+ # This was tag 1.9.0 on 2024-07-30
+ uses: pypa/gh-action-pypi-publish@ec4db0b4ddc65acdf4bff5fa45ac92d78b56bdf0
 
 
  coverage:
@@ -277,7 +278,7 @@ jobs:
  - uses: actions/setup-python@v4
  with:
  # Use latest Python, so it understands all syntax.
- python-version: 3.11
+ python-version: 3.12
 
  - run: python -Im pip install --upgrade coverage[toml]
 

diff --git a/NEWS.rst b/NEWS.rst
@@ -5,6 +5,64 @@ Release notes
 
 .. towncrier release notes start
 
+Towncrier 24.7.0 (2024-07-31)
+=============================
+
+No changes since the previous release candidate.
+
+
+Features
+--------
+
+- ``towncrier build`` now handles removing news fragments which are not part of the git repository. For example, uncommitted or unstaged files. (`#357 <https://github.com/twisted/towncrier/issues/357>`_)
+- Inferring the version of a Python package now tries to use the metadata of the installed package before importing the package explicitly (which only looks for ``[package].__version__``). (`#432 <https://github.com/twisted/towncrier/issues/432>`_)
+- If no filename is given when doing ``towncrier`` create, interactively ask for the issue number and fragment type (and then launch an interactive editor for the fragment content).
+
+ Now by default, when creating a fragment it will be appended with the ``filename`` option's extension (unless an extension is explicitly provided). For example, ``towncrier create 123.feature`` will create ``news/123.feature.rst``. This can be changed in configuration file by setting `add_extension = false`.
+
+ A new line is now added by default to the end of the fragment contents. This can be reverted in the configuration file by setting `add_newline = false`. (`#482 <https://github.com/twisted/towncrier/issues/482>`_)
+- The temporary file ``towncrier create`` creates now uses the correct ``.rst`` or ``.md`` extension, which may help your editor with with syntax highlighting. (`#594 <https://github.com/twisted/towncrier/issues/594>`_)
+- Running ``towncrier`` will now traverse back up directories looking for the configuration file. (`#601 <https://github.com/twisted/towncrier/issues/601>`_)
+- The ``towncrier create`` action now uses sections defined in your config (either interactively, or via the new ``--section`` option). (`#603 <https://github.com/twisted/towncrier/issues/603>`_)
+- News fragments are now sorted by issue number even if they have non-digit characters.
+
+ For example::
+
+ - some issue (gh-3, gh-10)
+ - another issue (gh-4)
+ - yet another issue (gh-11)
+
+ The sorting algorithm groups the issues first by non-text characters and then by number. (`#608 <https://github.com/twisted/towncrier/issues/608>`_)
+- The ``title_format`` configuration option now uses a markdown format for markdown templates. (`#610 <https://github.com/twisted/towncrier/issues/610>`_)
+- newsfragment categories can now be marked with ``check = false``, causing them to be ignored in ``towncrier check`` (`#617 <https://github.com/twisted/towncrier/issues/617>`_)
+- ``towncrier check`` will now fail if any news fragments have invalid filenames.
+
+ Added a new configuration option called ``ignore`` that allows you to specify a list of filenames that should be ignored. If this is set, ``towncrier build`` will also fail if any filenames are invalid, except for those in the list. (`#622 <https://github.com/twisted/towncrier/issues/622>`_)
+
+
+Bugfixes
+--------
+
+- Add explicit encoding to read_text. (`#561 <https://github.com/twisted/towncrier/issues/561>`_)
+- The default Markdown template now renders a title containing the release version and date, even when the `name` configuration is left empty. (`#587 <https://github.com/twisted/towncrier/issues/587>`_)
+- Orphan news fragments, fragments not associated with an issue, consisting of only digits (e.g. '+12345678.feature') now retain their leading marker character. (`#588 <https://github.com/twisted/towncrier/issues/588>`_)
+- Orphan news fragments, fragments not associated with an issue, will now still show in categories that are marked to not show content, since they do not have an issue number to show. (`#612 <https://github.com/twisted/towncrier/issues/612>`_)
+
+
+Improved Documentation
+----------------------
+
+- Clarify version discovery behavior. (`#432 <https://github.com/twisted/towncrier/issues/432>`_, `#602 <https://github.com/twisted/towncrier/issues/602>`_)
+- The tutorial now introduces the `filename` option in the appropriate paragraph and mentions its default value. (`#586 <https://github.com/twisted/towncrier/issues/586>`_)
+- Add docs to explain how ``towncrier create +.feature.rst`` (orphan fragments) works. (`#589 <https://github.com/twisted/towncrier/issues/589>`_)
+
+
+Misc
+----
+
+- `#491 <https://github.com/twisted/towncrier/issues/491>`_, `#561 <https://github.com/twisted/towncrier/issues/561>`_, `#562 <https://github.com/twisted/towncrier/issues/562>`_, `#568 <https://github.com/twisted/towncrier/issues/568>`_, `#569 <https://github.com/twisted/towncrier/issues/569>`_, `#571 <https://github.com/twisted/towncrier/issues/571>`_, `#574 <https://github.com/twisted/towncrier/issues/574>`_, `#575 <https://github.com/twisted/towncrier/issues/575>`_, `#582 <https://github.com/twisted/towncrier/issues/582>`_, `#591 <https://github.com/twisted/towncrier/issues/591>`_, `#596 <https://github.com/twisted/towncrier/issues/596>`_, `#597 <https://github.com/twisted/towncrier/issues/597>`_, `#625 <https://github.com/twisted/towncrier/issues/625>`_
+
+
 towncrier 23.11.0 (2023-11-08)
 ==============================
 

diff --git a/RELEASE.rst b/RELEASE.rst
@@ -59,6 +59,25 @@ For now, the GitHub release text is reStructuredText as it's easy to copy and pa
 In the future we might create a separate Markdown version.
 
 
+Release candidate publish failures
+----------------------------------
+
+The PyPI publish process is automatically triggered when a tag is created.
+
+The publish is skipped for PRs, so we can check that the automated process works only a release time.
+It can happen for the automated publish process to fail.
+
+As long as the package was not published to PyPI, do the followings:
+
+* Manually delete the candidate release from GitHub releases
+* Manually delete the tag for the release candidate
+
+Try to fix the issue and trigger the same release candidate again.
+
+Once the package is published on PyPI, do not delete the release or the tag.
+Proceed with create a new release candidate instead.
+
+
 Final release
 -------------
 

diff --git a/src/towncrier/_version.py b/src/towncrier/_version.py
@@ -2,11 +2,11 @@
 Provides towncrier version information.
 """
 
-# For dev - 23.11.1.dev0
-# For RC - 23.11.1.rc1
-# For final - 23.11.1
+# For dev - 23.11.0.dev0
+# For RC - 23.11.0rc1 (release candidate starts at 1)
+# For final - 23.11.0
 # make sure to follow PEP440
-__version__ = "23.11.1.dev0"
+__version__ = "24.7.1.dev0"
 
 _hatchling_version = __version__
 __all__ = ["_hatchling_version"]
diff --git a/src/towncrier/newsfragments/357.feature.rst b/src/towncrier/newsfragments/357.feature.rst
diff --git a/src/towncrier/newsfragments/432.doc.rst b/src/towncrier/newsfragments/432.doc.rst
diff --git a/src/towncrier/newsfragments/432.feature.rst b/src/towncrier/newsfragments/432.feature.rst
diff --git a/src/towncrier/newsfragments/482.feature.rst b/src/towncrier/newsfragments/482.feature.rst
diff --git a/src/towncrier/newsfragments/491.misc b/src/towncrier/newsfragments/491.misc
diff --git a/src/towncrier/newsfragments/561.bugfix.rst b/src/towncrier/newsfragments/561.bugfix.rst
diff --git a/src/towncrier/newsfragments/561.misc.rst b/src/towncrier/newsfragments/561.misc.rst
diff --git a/src/towncrier/newsfragments/562.misc b/src/towncrier/newsfragments/562.misc
diff --git a/src/towncrier/newsfragments/568.misc b/src/towncrier/newsfragments/568.misc
diff --git a/src/towncrier/newsfragments/569.misc.rst b/src/towncrier/newsfragments/569.misc.rst
diff --git a/src/towncrier/newsfragments/571.misc b/src/towncrier/newsfragments/571.misc
diff --git a/src/towncrier/newsfragments/574.misc b/src/towncrier/newsfragments/574.misc
diff --git a/src/towncrier/newsfragments/575.misc b/src/towncrier/newsfragments/575.misc
diff --git a/src/towncrier/newsfragments/582.misc b/src/towncrier/newsfragments/582.misc
diff --git a/src/towncrier/newsfragments/586.doc b/src/towncrier/newsfragments/586.doc
diff --git a/src/towncrier/newsfragments/587.bugfix b/src/towncrier/newsfragments/587.bugfix
diff --git a/src/towncrier/newsfragments/588.bugfix b/src/towncrier/newsfragments/588.bugfix
diff --git a/src/towncrier/newsfragments/589.doc b/src/towncrier/newsfragments/589.doc
diff --git a/src/towncrier/newsfragments/591.misc.rst b/src/towncrier/newsfragments/591.misc.rst
diff --git a/src/towncrier/newsfragments/594.feature.rst b/src/towncrier/newsfragments/594.feature.rst
diff --git a/src/towncrier/newsfragments/596.misc.rst b/src/towncrier/newsfragments/596.misc.rst
diff --git a/src/towncrier/newsfragments/597.misc.rst b/src/towncrier/newsfragments/597.misc.rst
diff --git a/src/towncrier/newsfragments/601.feature.rst b/src/towncrier/newsfragments/601.feature.rst
diff --git a/src/towncrier/newsfragments/602.doc.rst b/src/towncrier/newsfragments/602.doc.rst
diff --git a/src/towncrier/newsfragments/603.feature.rst b/src/towncrier/newsfragments/603.feature.rst
diff --git a/src/towncrier/newsfragments/608.feature.rst b/src/towncrier/newsfragments/608.feature.rst
diff --git a/src/towncrier/newsfragments/610.feature.rst b/src/towncrier/newsfragments/610.feature.rst
diff --git a/src/towncrier/newsfragments/612.bugfix.rst b/src/towncrier/newsfragments/612.bugfix.rst
diff --git a/src/towncrier/newsfragments/617.feature.rst b/src/towncrier/newsfragments/617.feature.rst
diff --git a/src/towncrier/newsfragments/622.feature.rst b/src/towncrier/newsfragments/622.feature.rst
diff --git a/src/towncrier/newsfragments/625.misc b/src/towncrier/newsfragments/625.misc