Checklist for a New Release

It is to note that this checklist is used by the Ikarus Developers for a new release of the library. In order to learn more about the usage aspects of Ikarus, refer to the documentation.

For a new release, the following steps are to be carried out:

• add new version in dune.module
• Change version in CMakeLists.txt
• Check if all release files are created correctly (Docker containers, ikarus-examples,...)
• Ensure CHANGELOG.md is updated correctly with all significant pull request details
• Update LICENSE.md if new contributors are added
• Check if Python deps are working
• Rebase private repositories to the new release
• *.zip files have to be zipped again before uploading it to DaRUS.
• Push the tag with version the name written as v*.*, create annotated tag!!! git tag -a! https://stackoverflow.com/questions/5002555/can-a-lightweight-tag-be-converted-to-an-annotated-tag Since the release workflow replaces the tag with a lightweight tag, we have to run git tag -a v0.4 -m "Create release v0.4" --force and push the tag to have a annotated tag, which are needed for software inheritance
• git tag -a v0.4 -m "Create release v0.4" --forc
• https://www.seanh.cc/2022/05/21/publishing-python-packages-from-github-actions/

Updates to be done after receiving a DOI:

• Update the release badge in README.md
• Add badges to doi and software heritage https://archive.softwareheritage.org/browse/origin/directory/?origin_url=https://github.com/ikarus-project/ikarus
• Check readmes at docker hub
• Update docs/website/doxygen/mainpage.md
• Update release notes. It should contain the sections "What's Changed?", "Full Change Log," "Blog Posts Added". As a reference, the release notes of v0.3 can be used.
• Update citation details in ikarus/utils/init.hh
• Update the badges at https://pypi.org/project/pyikarus/ --> This should be automatically updated
• Update the About page -> Datasets and How to cite us?