|
2 | 2 |
|
3 | 3 | .. towncrier release notes start |
4 | 4 |
|
| 5 | +towncrier 19.9.0 (2021-03-20) |
| 6 | +============================= |
| 7 | + |
| 8 | +No significant changes. |
| 9 | + |
| 10 | + |
| 11 | +towncrier 19.9.0rc1 (2019-09-16) |
| 12 | +================================ |
| 13 | + |
| 14 | +Features |
| 15 | +-------- |
| 16 | + |
| 17 | +- Add ``create`` subcommand, which can be used to quickly create a news |
| 18 | + fragment command in the location defined by config. (`#4 <https://github.com/hawkowl/towncrier/issues/4>`_) |
| 19 | +- Add support for subcommands, meaning the functionality of the ``towncrier`` |
| 20 | + executable is now replaced by the ``build`` subcommand:: |
| 21 | + |
| 22 | + $ towncrier build --draft |
| 23 | + |
| 24 | + A new ``check`` subcommand is exposed. This is an alternative to calling the |
| 25 | + ``towncrier.check`` module manually:: |
| 26 | + |
| 27 | + $ towncrier check |
| 28 | + |
| 29 | + Calling ``towncrier`` without a subcommand will result in a call to the |
| 30 | + ``build`` subcommand to ensure backwards compatibility. This may be removed in a |
| 31 | + future release. (`#144 <https://github.com/hawkowl/towncrier/issues/144>`_) |
| 32 | +- 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>`_) |
| 33 | +- towncrier now accepts the --config argument to specify a custom configuration file (`#157 <https://github.com/hawkowl/towncrier/issues/157>`_) |
| 34 | +- There is now the option for ``all_bullets = false`` in the configuration. |
| 35 | + Setting ``all_bullets`` to false means that news fragments have to include |
| 36 | + the bullet point if they should be rendered as enumerations, otherwise |
| 37 | + they are rendered directly (this means fragments can include a header.). |
| 38 | + It is necessary to set this option to avoid (incorrect) automatic indentation |
| 39 | + of multiline fragments that do not include bullet points. |
| 40 | + The ``single-file-no-bullets.rst`` template gives an example of |
| 41 | + using these options. (`#158 <https://github.com/hawkowl/towncrier/issues/158>`_) |
| 42 | +- 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>`_) |
| 43 | +- 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>`_) |
| 44 | + |
| 45 | + |
| 46 | +Bugfixes |
| 47 | +-------- |
| 48 | + |
| 49 | +- Accept newsfragment filenames with multiple dots, like `fix-1.2.3.bugfix`. (`#142 <https://github.com/hawkowl/towncrier/issues/142>`_) |
| 50 | + |
| 51 | + |
| 52 | +Deprecations and Removals |
| 53 | +------------------------- |
| 54 | + |
| 55 | +- The `--pyproject` option for `towncrier check` is now replaced with `--config`, for consistency with other commands. (`#162 <https://github.com/hawkowl/towncrier/issues/162>`_) |
| 56 | + |
| 57 | + |
5 | 58 | towncrier 19.2.0 (2019-02-15) |
6 | 59 | ============================= |
7 | 60 |
|
|
0 commit comments