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

Release 21.3.0 #332

merged 9 commits into from
Apr 6, 2021

Conversation

altendky
Copy link
Member

No description provided.

@codecov
Copy link

codecov bot commented Mar 22, 2021

Codecov Report

Merging #332 (0182019) into master (19eb09b) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #332   +/-   ##
=======================================
  Coverage   96.78%   96.78%           
=======================================
  Files          20       20           
  Lines        1182     1182           
  Branches      106      106           
=======================================
  Hits         1144     1144           
  Misses         20       20           
  Partials       18       18           
Impacted Files Coverage Δ
src/towncrier/_version.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 19eb09b...0182019. Read the comment docs.

@altendky
Copy link
Member Author

Ready for the first review for tagging and publishing 21.3.0rc1.

Release email draft...


towncrier releases 19.9.0 and 21.3.0rc1

There are a couple towncrier releases... in process. This is a bit more complicated than normal since 19.9.0rc1 was never followed by a non-RC release. You can see a detailed checklist and discussion of this in #313 0. 19.9.0 artifacts have been created 1 and are ready to be published, but are being held. Relative to 19.9.0rc1, 19.9.0 contains a few readme fixes and the news fragments processed into news file. 21.3.0rc1 has been published and is open for a week for feedback before 21.3.0 is planned to be released. 19.9.0 publishing is being held until after 21.3.0 to avoid a somewhat pointless intermediate step for developers that are using 'the latest non-pre release on PyPI' (presently 19.2.0). No real need for someone to get 19.9.0 now just to see 21.3.0 available next week. The news for 21.3.0 is available for review 2.

There are remaining bugs and important features. But, it took long enough to get to this point that I consider it important to get something out. Several people are waiting patiently 3. As we find time to design and address the remaining issues, hopefully we can manage more frequent releases.

Please do let me know of any issues you find that are not already documented. Or, if any of the documented ones should really be release blockers. I sure hope we can get this out though. :]

Cheers,
-kyle

NEWS.rst Outdated
Comment on lines 43 to 46
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?

@adiroiban
Copy link
Member

My suggestion for the email


Subject: towncrier releases 19.9.0 and 21.3.0rc1

Hi everyone,

I am announcing 2 twisted releases.

This is a bit more complicated than normal since 19.9.0rc1 was never followed by a non-RC release.

You can see a detailed checklist and discussion of this in #313 0.

Relative to 19.9.0rc1, 19.9.0 contains a few readme fixes and the news fragments processed into news file.

19.9.0 artifacts have been created 1 and 19.9.0 publishing is being held until after 21.3.0 to avoid a somewhat pointless intermediate step for developers that are using 'the latest non-pre release on PyPI' (presently 19.2.0).
No real need for someone to get 19.9.0 now just to see 21.3.0 available next week. The news for 21.3.0 is available for review 2.

21.3.0rc1 has been published and is open for a week for feedback before 21.3.0 is planned to be released.

There are remaining bugs and important features. But, it took long enough to get to this point that I consider it important to get something out. Several people are waiting patiently 3. As we find time to design and address the remaining issues, hopefully we can manage more frequent releases.

Please do let me know of any issues you find that are not already documented. Or, if any of the documented ones should really be release blockers. I sure hope we can get this out though. :]

Cheers,
-kyle

adiroiban
adiroiban previously approved these changes Mar 26, 2021
Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

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

All good. Thanks!

NEWS.rst Outdated
Comment on lines 43 to 46
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

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?

@altendky
Copy link
Member Author

altendky commented Mar 26, 2021

So, that's cool. pep517.meta seems to normalize dev4 and rc1 differently in regards to a . or not...

$ grep "__version__" src/towncrier/_version.py
__version__ = Version("towncrier", 21, 3, 0, release_candidate=1)
__all__ = ["__version__"]
$ venv/bin/python -c 'import pep517.meta; print(pep517.meta.load(".").version)'
WARNING: You are using pip version 20.3.3; however, version 21.0.1 is available.
You should consider upgrading via the '/home/altendky/repos/towncrier/venv/bin/python -m pip install --upgrade pip' command.
WARNING: You are using pip version 20.3.3; however, version 21.0.1 is available.
You should consider upgrading via the '/home/altendky/repos/towncrier/venv/bin/python -m pip install --upgrade pip' command.
21.3.0rc1
$ grep "__version__" src/towncrier/_version.py
__version__ = Version("towncrier", 21, 3, 0, dev=4)
__all__ = ["__version__"]
$ venv/bin/python -c 'import pep517.meta; print(pep517.meta.load(".").version)'
WARNING: You are using pip version 20.3.3; however, version 21.0.1 is available.
You should consider upgrading via the '/home/altendky/repos/towncrier/venv/bin/python -m pip install --upgrade pip' command.
WARNING: You are using pip version 20.3.3; however, version 21.0.1 is available.
You should consider upgrading via the '/home/altendky/repos/towncrier/venv/bin/python -m pip install --upgrade pip' command.
21.3.0.dev4
$ venv/bin/python -c 'import incremental; versions = [incremental.Version("", 21, 3, 0, dev=4), incremental.Version("", 21, 3, 0, release_candidate=1)]; print("\n".join(version.public() for version in versions))'
21.3.0.dev4
21.3.0.rc1

And thus we get...

https://github.com/twisted/towncrier/runs/2198852633?check_suite_focus=true
image

Just manually upload the CI artifacts to PyPI? Delete the tag, choose how to fix this, go again? Just push tag 21.3.0rc1? Maybe this comparison should use packaging.utils.canonicalize_version() so it is less sensitive.

@graingert, @adiroiban

@adiroiban
Copy link
Member

Just manually upload the CI artifacts to PyPI? Delete the tag, choose how to fix this, go again? Just push tag 21.3.0rc1? Maybe this comparison should use packaging.utils.canonicalize_version() so it is less sensitive.

I think you can do a manual upload.... and we can look at updating incremental or more probably update "admin/check_tag_version_match.py" to use the same incremental version

The normalization done by pep517 module is the one described in PEP440.

Thanks

@altendky
Copy link
Member Author

The weird bit about pep517.meta/pip is that it outputs 21.3.0.dev4 (with the .) but also 21.3.0rc1 (without the .). Which is why it worked for the test, using .dev4, but failed here with .rc1.

https://www.python.org/dev/peps/pep-0440/#pre-release-separators

Pre-releases should allow a ., -, or _ separator between the release segment and the pre-release segment. The normal form for this is without a separator.

pep517.meta.load().version doesn't, by way of its name, exactly claim to normalize. But, it is a bit odd that it does, partially, in one case and doesn't also apply the same change not in another case.

@altendky altendky marked this pull request as ready for review March 26, 2021 13:12
@altendky altendky dismissed adiroiban’s stale review March 26, 2021 13:13

rc1 has been uploaded, resetting for approval of next tag

@altendky altendky marked this pull request as draft March 26, 2021 13:13
@altendky
Copy link
Member Author

altendky commented Apr 3, 2021

Oh huh, that's fun... Since we build on-tag and we tag on-the-PR-branch and we build on-PR... we double up here.

image

@altendky altendky mentioned this pull request Apr 3, 2021
3 tasks
@altendky altendky marked this pull request as ready for review April 3, 2021 03:19
@altendky altendky requested a review from adiroiban April 3, 2021 03:20
@adiroiban
Copy link
Member

Oh huh, that's fun... Since we build on-tag and we tag on-the-PR-branch and we build on-PR... we double up here.

Which build is this?


I see CI / Check Newsfragment failing on the release branch and I think there is already a reported issue and maybe a PR...
So I think that we should prioritize this bug.

I think that adding a newsfragment as in bd963c3 should not be part of a normal release process

adiroiban
adiroiban previously approved these changes Apr 5, 2021
Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

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

All good. Thanks. Ready for final release :)

Maybe future work.

  • Fix towncrier release check to not complain about missing news fragment for a release branch.... the logic should be reversed for a release and complain if there are newsfragments
  • Maybe add a help CLI to generate a final release section with current date and time and maybe with a body like No changes since the previous release.

NEWS.rst Outdated Show resolved Hide resolved
Co-authored-by: Adi Roiban <[email protected]>
@altendky
Copy link
Member Author

altendky commented Apr 5, 2021

  • Fix towncrier release check to not complain about missing news fragment for a release branch.... the logic should be reversed for a release and complain if there are newsfragments

I think that's #309. Or at least closely related.

  • Maybe add a help CLI to generate a final release section with current date and time and maybe with a body like No changes since the previous release.

This sounds like a bigger suggestion but all I see as different than present functionality is the addition of time to the template and the change in wording of the 'nothing to see here' comment when there are no newsfragments.

@adiroiban
Copy link
Member

Thanks for the ticket link.
The CLI was a suggestion for a separate future feature... not sure if that is common.

@altendky
Copy link
Member Author

altendky commented Apr 5, 2021

I'm not clear in what scenario we would need a separate CLI (or subcommand or...) for doing that. Presumably I don't understand the feature yet. Feel free to pick whatever communications option you see fit to help me understand. :]

@altendky altendky dismissed adiroiban’s stale review April 5, 2021 23:33

21.3.0 released, now to catch this up and so on and then a final review before merging.

Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

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

All good. Thanks!

I don't think that a review is required for the master merge. But here we go :)

@altendky
Copy link
Member Author

altendky commented Apr 6, 2021

Welp, you failed at the review, sorry. I haven't updated the rev to be not-21.3.0 yet. I forgot to set it to draft before dismissing the review. This review/dismiss/review/... is not great. Haven't thought about how to change it though, other than _more_ PRs.

@altendky
Copy link
Member Author

altendky commented Apr 6, 2021

@adiroiban
Copy link
Member

Welp, you failed at the review, sorry.

True. My bad.

@altendky
Copy link
Member Author

altendky commented Apr 6, 2021

Should have put a smiley on that. Hopefully you can accept this backwards one retroactively. [:

@altendky altendky merged commit 6385f70 into master Apr 6, 2021
@altendky altendky deleted the release-21.3.0 branch April 6, 2021 02:16
@adiroiban
Copy link
Member

Don't worry. It was really my fault and should have done a better review.
This is volunteer work, but we should still keep a high degree of quality.
Cheers

wip-sync referenced this pull request in NetBSD/pkgsrc-wip May 5, 2023
towncrier 22.12.0 (2022-12-21)
==============================

No changes since the previous release candidate.

towncrier 22.12.0rc1 (2022-12-20)
=================================

Features
--------

- Added ``--keep`` option to the ``build`` command that allows generating a newsfile, but keeps the newsfragments in place.
  This option can not be used together with ``--yes``. (`#129 <https://github.com/hawkowl/towncrier/issues/129>`_)
- Python 3.11 is now officially supported. (`#427 <https://github.com/hawkowl/towncrier/issues/427>`_)
- You can now create fragments that are not associated with issues. Start the name of the fragment with ``+`` (e.g. ``+anything.feature``).
  The content of these orphan news fragments will be included in the release notes, at the end of the category corresponding to the file extension.

  To help quickly create a unique orphan news fragment, ``towncrier create +.feature`` will append a random string to the base name of the file, to avoid name collisions. (`#428 <https://github.com/hawkowl/towncrier/issues/428>`_)

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

- Improved contribution documentation. (`#415 <https://github.com/hawkowl/towncrier/issues/415>`_)
- Correct a typo in the readme that incorrectly documented custom fragments in a format that does not work. (`#424 <https://github.com/hawkowl/towncrier/issues/424>`_)
- The documentation has been restructured and (hopefully) improved. (`#435 <https://github.com/hawkowl/towncrier/issues/435>`_)
- Added a Markdown-based how-to guide. (`#436 <https://github.com/hawkowl/towncrier/issues/436>`_)
- Defining custom fragments using a TOML array is not deprecated anymore. (`#438 <https://github.com/hawkowl/towncrier/issues/438>`_)

Deprecations and Removals
-------------------------

- Default branch for `towncrier check` is now "origin/main" instead of "origin/master".
  If "origin/main" does not exist, fallback to "origin/master" with a deprecation warning. (`#400 <https://github.com/hawkowl/towncrier/issues/400>`_)

Misc
----

- `#406 <https://github.com/hawkowl/towncrier/issues/406>`_, `#408 <https://github.com/hawkowl/towncrier/issues/408>`_, `#411 <https://github.com/hawkowl/towncrier/issues/411>`_, `#412 <https://github.com/hawkowl/towncrier/issues/412>`_, `#413 <https://github.com/hawkowl/towncrier/issues/413>`_, `#414 <https://github.com/hawkowl/towncrier/issues/414>`_, `#416 <https://github.com/hawkowl/towncrier/issues/416>`_, `#418 <https://github.com/hawkowl/towncrier/issues/418>`_, `#419 <https://github.com/hawkowl/towncrier/issues/419>`_, `#421 <https://github.com/hawkowl/towncrier/issues/421>`_, `#429 <https://github.com/hawkowl/towncrier/issues/429>`_, `#430 <https://github.com/hawkowl/towncrier/issues/430>`_, `#431 <https://github.com/hawkowl/towncrier/issues/431>`_, `#434 <https://github.com/hawkowl/towncrier/issues/434>`_, `#446 <https://github.com/hawkowl/towncrier/issues/446>`_, `#447 <https://github.com/hawkowl/towncrier/issues/447>`_

towncrier 22.8.0 (2022-08-29)
=============================

No significant changes since the previous release candidate.

towncrier 22.8.0.rc1 (2022-08-28)
=================================

Features
--------

- Make the check subcommand succeed for branches that change the news file

  This should enable the ``check`` subcommand to be used as a CI lint step and
  not fail when a pull request only modifies the configured news file (i.e. when
  the news file is being assembled for the next release). (`#337 <https://github.com/hawkowl/towncrier/issues/337>`_)
- Added support to tables in toml settings, which provides a more intuitive
  way to configure custom types. (`#369 <https://github.com/hawkowl/towncrier/issues/369>`_)
- The `towncrier create` command line now has a new `-m TEXT` argument that is used to define the content of the newly created fragment. (`#374 <https://github.com/hawkowl/towncrier/issues/374>`_)

Bugfixes
--------

- The extra newline between the title and rendered content when using ``--draft`` is no longer inserted. (`#105 <https://github.com/hawkowl/towncrier/issues/105>`_)
- The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.

  Support for having the release notes for each version in a separate file is working again. This is a regression introduced in VERSION 19.9.0rc1. (`#391 <https://github.com/hawkowl/towncrier/issues/391>`_)

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

- Improve ``CONTRIBUTING.rst`` and add PR template. (`#342 <https://github.com/hawkowl/towncrier/issues/342>`_)
- Move docs too the main branch and document custom fragment types. (`#367 <https://github.com/hawkowl/towncrier/issues/367>`_)
- The CLI help messages were updated to contain more information. (`#384 <https://github.com/hawkowl/towncrier/issues/384>`_)

Deprecations and Removals
-------------------------

- Support for all Python versions older than 3.7 has been dropped. (`#378 <https://github.com/hawkowl/towncrier/issues/378>`_)

Misc
----

- `#292 <https://github.com/hawkowl/towncrier/issues/292>`_, `#330 <https://github.com/hawkowl/towncrier/issues/330>`_, `#366 <https://github.com/hawkowl/towncrier/issues/366>`_, `#376 <https://github.com/hawkowl/towncrier/issues/376>`_, `#377 <https://github.com/hawkowl/towncrier/issues/377>`_, `#380 <https://github.com/hawkowl/towncrier/issues/380>`_, `#381 <https://github.com/hawkowl/towncrier/issues/381>`_, `#382 <https://github.com/hawkowl/towncrier/issues/382>`_, `#383 <https://github.com/hawkowl/towncrier/issues/383>`_, `#393 <https://github.com/hawkowl/towncrier/issues/393>`_, `#399 <https://github.com/hawkowl/towncrier/issues/399>`_, `#402 <https://github.com/hawkowl/towncrier/issues/402>`_

towncrier 21.9.0 (2022-02-04)
=============================

Features
--------

- towncrier --version` was added to the command line interface to show the product version. (`#339 <https://github.com/hawkowl/towncrier/issues/339>`_)
- Support Toml v1 syntax with tomli on Python 3.6+ (`#354 <https://github.com/hawkowl/towncrier/issues/354>`_)

Bugfixes
--------

- Stop writing title twice when ``title_format`` is specified. (`#346 <https://github.com/hawkowl/towncrier/issues/346>`_)
- Disable universal newlines when reading TOML (`#359 <https://github.com/hawkowl/towncrier/issues/359>`_)

Misc
----

- `#332 <https://github.com/hawkowl/towncrier/issues/332>`_, `#333 <https://github.com/hawkowl/towncrier/issues/333>`_, `#334 <https://github.com/hawkowl/towncrier/issues/334>`_, `#338 <https://github.com/hawkowl/towncrier/issues/338>`_

towncrier 21.3.0 (2021-04-02)
=============================

No significant changes since the previous release candidate.

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

Features
--------

- Ticket number from file names will be stripped down to avoid ticket links such as ``#7``. (`#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>`_)

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

No significant changes.

towncrier 19.9.0rc1 (2019-09-16)
================================

Features
--------

- Add ``create`` subcommand, which can be used to quickly create a news
  fragment command in the location defined by config. (`#4 <https://github.com/hawkowl/towncrier/issues/4>`_)
- Add support for subcommands, meaning the functionality of the ``towncrier``
  executable is now replaced by the ``build`` subcommand::

      $ towncrier build --draft

  A new ``check`` subcommand is exposed. This is an alternative to calling the
  ``towncrier.check`` module manually::

      $ towncrier check

  Calling ``towncrier`` without a subcommand will result in a call to the
  ``build`` subcommand to ensure backwards compatibility. This may be removed in a
  future release. (`#144 <https://github.com/hawkowl/towncrier/issues/144>`_)
- Towncrier's templating now allows configuration of the version header. *CUSTOM TEMPLATE USERS PLEASE NOTE: You will need to add the version header information to your template!* (`#147 <https://github.com/hawkowl/towncrier/issues/147>`_)
- towncrier now accepts the --config argument to specify a custom configuration file (`#157 <https://github.com/hawkowl/towncrier/issues/157>`_)
- There is now the option for ``all_bullets = false`` in the configuration.
  Setting ``all_bullets`` to false means that news fragments have to include
  the bullet point if they should be rendered as enumerations, otherwise
  they are rendered directly (this means fragments can include a header.).
  It is necessary to set this option to avoid (incorrect) automatic indentation
  of multiline fragments that do not include bullet points.
  The ``single-file-no-bullets.rst`` template gives an example of
  using these options. (`#158 <https://github.com/hawkowl/towncrier/issues/158>`_)
- The ``single_file`` option can now be added to the configuration file. When set to ``true``, the filename key can now be formattable with the ``name``, ``version``, and ``project_date`` format variables. This allows subsequent versions to be written out to new files instead of appended to an existing one. (`#161 <https://github.com/hawkowl/towncrier/issues/161>`_)
- You can now specify Towncrier-bundled templates in your configuration file. Available templates are `default`, `hr-between-versions` (as used in attrs), and `single-file-no-bullets`. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_)

Bugfixes
--------

- Accept newsfragment filenames with multiple dots, like `fix-1.2.3.bugfix`. (`#142 <https://github.com/hawkowl/towncrier/issues/142>`_)

Deprecations and Removals
-------------------------

- The `--pyproject` option for `towncrier check` is now replaced with `--config`, for consistency with other commands. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants