Skip to content

Keep a changelog and towncrier

Fixes #12.

Workflow

  • Every MR should end with a news fragment created as:
towncrier create 43.added

and edited by the contributor it as necessary. Two news fragments are added to show how it works

  • Every release can generate a release note as follows
towncrier build --version 0.3.3

which could be copied into is generated inline in CHANGES.rst

see README for more details.

Demo

❯ towncrier build --version 0.3.3 --draft                                           
Loading template...
Finding news fragments...
Rendering news fragments...
Draft only -- nothing has been written.
What is seen below is what would be written.

.. _Unreleased: https://foss.heptapod.net/fluiddyn/fluiddyn/-/compare/0.3.3...branch%2Fdefault

0.3.3_ (2020-07-04)
-------------------

Changed
~~~~~~~
* `!42 <https://foss.heptapod.net/fluiddyn/fluiddyn/-/merge_requests/42>`__ : Changelog automation

  - Keep a changelog style for changes
  - Use ``towncrier`` for changelog generation
  
Removed
~~~~~~~
* `!41 <https://foss.heptapod.net/fluiddyn/fluiddyn/-/merge_requests/41>`__ : Remove buggy ``__init__, fft, ifft`` methods from `:class:FFTW1DReal2Complex` and fallback to parent `:class:BasePyFFT`
  
.. _0.3.3: https://foss.heptapod.net/fluiddyn/fluiddyn/-/compare/x.y.z...0.3.3
.. FIXME: replace x.y.z with previous version in the above line and remove old `_Unreleased` link below

EDIT: standalone release notes are avoided, added inline to CHANGES.rst instead.

Edited by Ashwin V. Mohanan

Merge request reports