Skip to content

Release procedure

Bernhard Manfred Gruber edited this page Feb 29, 2024 · 11 revisions

Preparation

  • All examples must build.
  • All unit tests must build and pass.
  • The documentation must build (check readthedocs).
  • Verify that the documentation is up-to-date.
  • Verify that the README.md is up-to-date.
  • Verify that the CHANGELOG.md is up-to-date.
  • Verify that CITATION.cff is up-to-date, especially regarding contributors.
  • Bump the version number in llama.hpp, docs/conf.py, vcpkg.json and CITATION.cff (version field).
  • Optionally create a release branch.
  • Test the release/develop branch in downstream projects (e.g. picongpu).

Release

  • Set release date in CHANGELOG.md and CITATION.cff (date-released field) and commit to release/develop branch.
  • Draft a new release on GitHub: https://github.com/alpaka-group/llama/releases.
    • Let Github created a tag from the release/develop branch naming it v{MAJOR_VERSION}.{MINOR_VERSION}
    • Release title: "Version {MAJOR_VERSION}.{MINOR_VERSION}"
    • Copy the section concerning this release from CHANGELOG.md into the description.
    • Publish
  • If any commits where added to the optional release branch, merge those back into develop.
Clone this wiki locally