Skip to content

Commit 2841c12

Browse files
altendkyhawkowl
andauthored
Release 19.9.0 (#331)
Co-authored-by: Amber H. Brown <[email protected]>
1 parent 7267fb5 commit 2841c12

File tree

12 files changed

+62
-34
lines changed

12 files changed

+62
-34
lines changed

NEWS.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,59 @@
22

33
.. towncrier release notes start
44
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+
558
towncrier 19.2.0 (2019-02-15)
659
=============================
760

README.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,20 +42,24 @@ In your project root, add a ``towncrier.toml`` or a ``pyproject.toml`` file (if
4242
You can configure your project in two ways.
4343
To configure it via an explicit directory, add:
4444

45-
.. code-block:: ini
45+
.. code-block:: toml
4646
4747
[tool.towncrier]
4848
directory = "changes"
4949
5050
Alternatively, to configure it relative to a (Python) package directory, add:
5151

52-
.. code-block:: ini
52+
.. code-block:: toml
5353
5454
[tool.towncrier]
5555
package = "mypackage"
5656
package_dir = "src"
5757
filename = "NEWS.rst"
5858
59+
.. note::
60+
61+
``towncrier`` will also look in ``pyproject.toml`` for configuration if ``towncrier.toml`` is not found.
62+
5963
For the latter, news fragments (see "News Fragments" below) should be in a ``newsfragments`` directory under your package.
6064
Using the above example, your news fragments would be ``src/myproject/newsfragments/``).
6165

@@ -126,7 +130,7 @@ Further Options
126130

127131
Towncrier has the following global options, which can be specified in the toml file:
128132

129-
.. code-block:: ini
133+
.. code-block:: toml
130134
131135
[tool.towncrier]
132136
package = ""
@@ -152,10 +156,10 @@ This can be useful if the specified template creates the title itself.
152156

153157
Furthermore, you can add your own fragment types using:
154158

155-
.. code-block:: ini
159+
.. code-block:: toml
156160
157161
[tool.towncrier]
158162
[[tool.towncrier.type]]
159163
directory = "deprecation"
160164
name = "Deprecations"
161-
showcontent = true
165+
showcontent = true

src/towncrier/newsfragments/142.bugfix

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/towncrier/newsfragments/144.feature.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

src/towncrier/newsfragments/147.feature

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/towncrier/newsfragments/157.feature

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/towncrier/newsfragments/158.feature

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/towncrier/newsfragments/161.feature

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/towncrier/newsfragments/162.feature

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/towncrier/newsfragments/162.removal

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)