Release Checklist

Release Checklist

Pre-release (on develop):

• Check that PETSc submodule is set to appropriate version
• Is CI passing?
• Run benchmark tests
• Update Xolotl VERSION in CMakeLists.txt
• Check dependency version requirements in calls to find_package
• Update README.md if necessary
• Commit these changes with message "Release v#.#.#"
• Push develop

Release:

• Switch to stable and merge develop
• Create tag with semantic version "v#.#.#"
• Push commit(s)
• Push tag (git push --tags)
• On GitHub, create a release from the tag
  • Use the "Generate release notes" feature
  • Link to the appropriate milestone issue

Post-release:

• Update Wiki if necessary (update the link to the latest release at least)
  • Check this page against params in help output