Changelogs » Towncrier

Towncrier

19.2.0

=============================

Features
--------

- Add support for multiple fragements per issue/type pair. This extends the
naming pattern of the fragments to `issuenumber.type(.counter)` where counter
is an optional integer. (`119 <https://github.com/hawkowl/towncrier/issues/119>`_)
- Python 2.7 is now supported. (`121 <https://github.com/hawkowl/towncrier/issues/121>`_)
- `python -m towncrier.check` now accepts an option to give the configuration file location. (`123 <https://github.com/hawkowl/towncrier/issues/123>`_)
- towncrier.check now reports git output when it encounters a git failure. (`124 <https://github.com/hawkowl/towncrier/issues/124>`_)

18.6.0

=============================

Features
--------

- ``python -m towncrier.check``, which will check a Git branch for the presence of added newsfiles, to be used in a CI system. (`75 <https://github.com/hawkowl/towncrier/issues/75>`_)
- wrap is now an optional configuration option (which is False by default) which controls line wrapping of news files. Towncrier will now also not attempt to normalise (wiping newlines) from the input, but will strip leading and ending whitespace. (`80 <https://github.com/hawkowl/towncrier/issues/80>`_)
- Towncrier can now be invoked by ``python -m towncrier``. (`115 <https://github.com/hawkowl/towncrier/issues/115>`_)


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

- Towncrier now supports Python 3.5+ as a script runtime. Python 2.7 will not function. (`80 <https://github.com/hawkowl/towncrier/issues/80>`_)

18.5.0

=============================

Features
--------

- Python 3.3 is no longer supported. (`103
<https://github.com/hawkowl/towncrier/issues/103>`_)
- Made ``package`` optional. When the version is passed on the command line,
and the ``title_format`` does not use the package name, and it is not used
for the path to the news fragments, then no package name is needed, so we
should not enforce it. (`111
<https://github.com/hawkowl/towncrier/issues/111>`_)


Bugfixes
--------

- When cleaning up old newsfragments, if a newsfragment is named
"123.feature.rst", then remove that file instead of trying to remove the
non-existent "123.feature". (`99
<https://github.com/hawkowl/towncrier/issues/99>`_)
- If there are two newsfragments with the same name (example: "123.bugfix.rst"
and "123.bugfix.rst~"), then raise an error instead of silently picking one
at random. (`101 <https://github.com/hawkowl/towncrier/issues/101>`_)

17.8.0

=============================

Features
--------

- Added new option ``issue_format``. For example, this can be used to make
issue text in the NEWS file be formatted as ReST links to the issue tracker.
(`52 <https://github.com/hawkowl/towncrier/issues/52>`_)
- Add ``--yes`` option to run non-interactively. (`56
<https://github.com/hawkowl/towncrier/issues/56>`_)
- You can now name newsfragments like 123.feature.rst, or 123.feature.txt, or
123.feature.whatever.you.want, and towncrier will ignore the extension. (`62
<https://github.com/hawkowl/towncrier/issues/62>`_)
- New option in ``pyproject.toml``: ``underlines = ["=", "-", "~"]`` to specify
the ReST underline hierarchy in towncrier's generated text. (`63
<https://github.com/hawkowl/towncrier/issues/63>`_)
- Instead of sorting sections/types alphabetically (e.g. "bugfix" before
"feature" because "b" < "f"), sections/types will now have the same order in
the output as they have in your config file. (`70
<https://github.com/hawkowl/towncrier/issues/70>`_)


Bugfixes
--------

- When rewrapping text, don't break words or at hyphens -- they might be inside
a URL (`68 <https://github.com/hawkowl/towncrier/issues/68>`_)


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

- `towncrier.ini` config file support has been removed in preference to
`pyproject.toml` configuration. (`71
<https://github.com/hawkowl/towncrier/issues/71>`_)

17.4.0

=============================

Misc
----

- 46

17.1.0

==========

Bugfixes
--------

- fix --date being ignored (43)

16.12.0

==========

Bugfixes
--------

- Towncrier will now import the local version of the package and not the global
one. (38)

Features
--------

- Allow configration of the template file, title text and "magic comment" (35)
- Towncrier now uses pyproject.toml, as defined in PEP-518. (40)

16.1.0

=============================

Features
--------

- Ported to Python 2.7. (27)
- towncrier now supports non-numerical news fragment names. (32)

Bugfixes
--------

- towncrier would spew an unhelpful exception if it failed importing
your project when autodiscovering, now it does not. (22)
- incremental is now added as a runtime dependency for towncrier.
(25)

Misc
----

- 33

16.0.0

=============================

Features
--------

- towncrier now automatically puts a date beside the version as it is
generated, using today's date. For repeatable builds, use the
``--date`` switch and provide a date. For no date, use ``--date=``.
(11)
- towncrier will now add the version logs after ``.. towncrier release
notes start``, if it is in the file, allowing you to preserve text
at the top of the file. (15)

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

- The README now mentions how to manually provide the version number,
for non-Py3 compatible projects. (19)

15.1.0

================

Features
--------

- towncrier now supports reading ``__version__`` attributes that are
tuples of numbers (e.g. (15, 4, 0)). (3)
- towncrier now has support for testing via Tox and each commit is now
ran on Travis CI. (6)

Bugfixes
--------

- towncrier now defaults to the current working directory for the
package_dir settings variable. (2)

15.0.0

================

Features
--------

- Basic functionality has been implemented. This includes configuring
towncrier to find your project, having a set of preconfigured news
fragment categories, and assembling a newsfile from them. (1)