Release 19.9.0 (#331)

Co-authored-by: Amber H. Brown <[email protected]>

NEWS.rst

@@ -2,6 +2,59 @@
 
 .. towncrier release notes start
 
+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>`_)
+
+
 towncrier 19.2.0 (2019-02-15)
 =============================
 

README.rst

@@ -42,20 +42,24 @@ In your project root, add a ``towncrier.toml`` or a ``pyproject.toml`` file (if
 You can configure your project in two ways.
 To configure it via an explicit directory, add:
 
-.. code-block:: ini
+.. code-block:: toml
 
     [tool.towncrier]
     directory = "changes"
 
 Alternatively, to configure it relative to a (Python) package directory, add:
 
-.. code-block:: ini
+.. code-block:: toml
 
     [tool.towncrier]
     package = "mypackage"
     package_dir = "src"
     filename = "NEWS.rst"
 
+.. note::
+
+    ``towncrier`` will also look in ``pyproject.toml`` for configuration if ``towncrier.toml`` is not found.
+
 For the latter, news fragments (see "News Fragments" below) should be in a ``newsfragments`` directory under your package.
 Using the above example, your news fragments would be ``src/myproject/newsfragments/``).
 
@@ -126,7 +130,7 @@ Further Options
 
 Towncrier has the following global options, which can be specified in the toml file:
 
-.. code-block:: ini
+.. code-block:: toml
 
     [tool.towncrier]
     package = ""
@@ -152,10 +156,10 @@ This can be useful if the specified template creates the title itself.
 
 Furthermore, you can add your own fragment types using:
 
-.. code-block:: ini
+.. code-block:: toml
 
     [tool.towncrier]
     [[tool.towncrier.type]]
     directory = "deprecation"
     name = "Deprecations"
-    showcontent = true
+    showcontent = true