Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 21.3.0 #332

Merged
merged 9 commits into from
Apr 6, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,50 @@

.. towncrier release notes start

towncrier 21.3.0.rc1 (2021-03-21)
=================================

Features
--------

- Ticket number from file names will be stripped down to avoid ticket links such as ``#007``. (`#126 <https://github.com/hawkowl/towncrier/issues/126>`_)
- Allow definition of the project ``version`` and ``name`` in the configuration file.
This allows use of towncrier seamlessly with non-Python projects. (`#165 <https://github.com/hawkowl/towncrier/issues/165>`_)
- Improve news fragment file name parsing to allow using file names like
``123.feature.1.ext`` which are convenient when one wants to use an appropriate
extension (e.g. ``rst``, ``md``) to enable syntax highlighting. (`#173 <https://github.com/hawkowl/towncrier/issues/173>`_)
- The new ``--edit`` option of the ``create`` subcommand launches an editor for entering the contents of the newsfragment. (`#275 <https://github.com/hawkowl/towncrier/issues/275>`_)
- CPython 3.8 and 3.9 are now part of our automated test matrix and are officially supported. (`#291 <https://github.com/hawkowl/towncrier/issues/291>`_)
- When searching for the project, first check for an existing importable instance.
This helps if the version is only available in the installed version and not the source. (`#297 <https://github.com/hawkowl/towncrier/issues/297>`_)
- Support building with PEP 517. (`#314 <https://github.com/hawkowl/towncrier/issues/314>`_)


Bugfixes
--------

- Configuration errors found during command line execution now trigger a message to stderr and no longer show a traceback. (`#84 <https://github.com/hawkowl/towncrier/issues/84>`_)
- A configuration error is triggered when the newsfragment files couldn't be discovered. (`#85 <https://github.com/hawkowl/towncrier/issues/85>`_)
- Invoking towncrier as `python -m towncrier` works. (`#163 <https://github.com/hawkowl/towncrier/issues/163>`_)
- ``check`` subcommand defaults to UTF-8 encoding when ``sys.stdout.encoding`` is ``None``.
This happens, for example, with Python 2 on GitHub Actions or when the output is piped. (`#175 <https://github.com/hawkowl/towncrier/issues/175>`_)
- Specifying ``title_format`` disables default top line creation to avoid duplication. (`#180 <https://github.com/hawkowl/towncrier/issues/180>`_)


Improved Documentation
----------------------

- The README now mentions the possibility to name the configuration file
``towncrier.toml`` (in addition to ``pyproject.toml``). (`#172 <https://github.com/hawkowl/towncrier/issues/172>`_)
- ``start_line`` corrected to ``start_string`` in the readme to match the long standing implementation. (`#277 <https://github.com/hawkowl/towncrier/issues/277>`_)


Misc
----

- `#167 <https://github.com/hawkowl/towncrier/issues/167>`_, `#279 <https://github.com/hawkowl/towncrier/issues/279>`_, `#286 <https://github.com/hawkowl/towncrier/issues/286>`_, `#287 <https://github.com/hawkowl/towncrier/issues/287>`_, `#291 <https://github.com/hawkowl/towncrier/issues/291>`_, `#293 <https://github.com/hawkowl/towncrier/issues/293>`_, `#295 <https://github.com/hawkowl/towncrier/issues/295>`_, `#299 <https://github.com/hawkowl/towncrier/issues/299>`_, `#305 <https://github.com/hawkowl/towncrier/issues/305>`_, `#315 <https://github.com/hawkowl/towncrier/issues/315>`_, `#316 <https://github.com/hawkowl/towncrier/issues/316>`_, `#317 <https://github.com/hawkowl/towncrier/issues/317>`_, `#324 <https://github.com/hawkowl/towncrier/issues/324>`_, `#327 <https://github.com/hawkowl/towncrier/issues/327>`_, `#329 <https://github.com/hawkowl/towncrier/issues/329>`_, `#331 <https://github.com/hawkowl/towncrier/issues/331>`_
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... Why did I think that misc was ignored... bah.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

towncrier/pyproject.toml

Lines 30 to 33 in 4143e0f

[[tool.towncrier.type]]
directory = "misc"
name = "Misc"
showcontent = false

Is this supposed to do what's above? Or totally not include it in the output? Guess I'll dive into the tests to try to understand.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that misc hasn't been used since 17.4.0 but it does look quite intentionally formatted. I guess this is good.

image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how towncrier works by default... and how it's used in Twisted (without the extra links).

It only hides the "content" and not the note number itself :p

I am using a custom template in which showcontent is completely ignored.

Maybe besides showcontent the default template can have a new ignore that can be used to now show that type at all in the release notes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comment. Can we manually remove the misc section?



towncrier 19.9.0 (2021-03-20)
=============================

Expand Down
2 changes: 1 addition & 1 deletion src/towncrier/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@

from incremental import Version

__version__ = Version("towncrier", 21, 3, 0, dev=4)
__version__ = Version("towncrier", 21, 3, 0, release_candidate=1)
__all__ = ["__version__"]
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/126.feature

This file was deleted.

1 change: 0 additions & 1 deletion src/towncrier/newsfragments/163.bugfix

This file was deleted.

2 changes: 0 additions & 2 deletions src/towncrier/newsfragments/165.feature.rst

This file was deleted.

1 change: 0 additions & 1 deletion src/towncrier/newsfragments/167.misc

This file was deleted.

2 changes: 0 additions & 2 deletions src/towncrier/newsfragments/172.doc.rst

This file was deleted.

3 changes: 0 additions & 3 deletions src/towncrier/newsfragments/173.feature.rst

This file was deleted.

2 changes: 0 additions & 2 deletions src/towncrier/newsfragments/175.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion src/towncrier/newsfragments/180.bugfix

This file was deleted.

1 change: 0 additions & 1 deletion src/towncrier/newsfragments/275.feature

This file was deleted.

1 change: 0 additions & 1 deletion src/towncrier/newsfragments/277.doc.rst

This file was deleted.

Empty file.
Empty file.
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/291.feature.rst

This file was deleted.

Empty file.
Empty file.
Empty file.
2 changes: 0 additions & 2 deletions src/towncrier/newsfragments/297.feature.rst

This file was deleted.

Empty file.
Empty file.
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/314.feature.rst

This file was deleted.

Empty file.
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/316.misc.rst

This file was deleted.

Empty file.
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/324.misc.rst

This file was deleted.

Empty file.
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/329.misc.rst

This file was deleted.

Empty file.
1 change: 0 additions & 1 deletion src/towncrier/newsfragments/84.bugfix.rst

This file was deleted.

1 change: 0 additions & 1 deletion src/towncrier/newsfragments/85.bugfix.rst

This file was deleted.