Skip to content

Commit

Permalink
Add simple Hook breaking change changelog entry
Browse files Browse the repository at this point in the history
  • Loading branch information
timofurrer committed Jul 21, 2020
1 parent 99effe7 commit e08029c
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Each file should be named like ``<ISSUE>.<TYPE>``, where

* ``feature``: new user facing features, like new command-line options and new behavior.
* ``bugfix``: fixes a reported bug.
* ``breaking``: a breaking change which is neither a new nor a removed feature.
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
* ``removal``: feature removal.

Expand Down
17 changes: 17 additions & 0 deletions changelog/simple_hooks.breaking
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
The simple Hooks using either ``@before`` or ``@after`` require to be called as a function.

The following Hook definition:

.. code-block:: python

@before.each_scenario
def setup(scenario):
pass

must be changed to:

.. code-block:: python

@before.each_scenario()
def setup(scenario):
pass
5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,8 @@ filename = "CHANGELOG.rst"
directory = "changelog/"
title_format = "radish-bdd {version} ({project_date})"
template = "changelog/template.rst"

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking"
showcontent = true

0 comments on commit e08029c

Please sign in to comment.