Release process

Note

The changelog is based on Keep a Changelog and it also uses the towncrier.toml

  1. Generate build as CHANGELOG.md with towncrier

$ towncrier build --version <version-number> # e.g.: towncrier build --version 0.1.2

  1. Go to Github Release UI.

  2. Choose a tag and select ‘create new tag and publish’.

  3. Set title <name> <tag version> e.g.: Agie 0.1.2

  4. Set the content based on CHANGELOG.md (copy and paste from it)

  5. For the rst file, execute (needs pandoc installed on system):

$ pandoc --from=markdown --to=rst --output=NEWS.rst CHANGELOG.md

  1. Update the documentation to use ‘NEWS.rst’ if isnt set yet, and run:

$ make clean # it's important to execute this before
$ make html

  1. Now push these new file changes and submit the release.