Checklists

New patch release

To publish a small fix as a patch release:

• make your changes based on the version branch (v${X}.${Y})

• change the version in pdi/VERSION

• change the version in pdi/docs/Installation.md

• change the version in README.md

• go over all CHANGELOG.md files and mark the just released version

• commit (or better, make a MR) in the version branch

• tag the new release: git tag -m "PDI release ${VERSION}" -s "${VERSION}"

• merge the version branch into master

• in the merge commit:

  • keep the content of pdi/VERSION from master (next with -alpha suffix)
  • keep the content of README.md and pdi/docs/Installation.md from master except with the version updated to the just released one

• make a new commit in the version branch (v${X}.${Y})

  • change the version in pdi/VERSION by increasing the patch and add the -alpha suffix

• push all that

New minor or major release

To publish a new minor or major release:

• start from the master branch

• change the version in pdi/VERSION

• change the version in pdi/docs/Installation.md

• change the version in README.md

• go over all CHANGELOG.md files and mark the just released version

• commit these changes into a new version branch (v${X}.${Y})

• tag the new release: git tag -m "PDI release ${VERSION}" -s "${VERSION}"

• merge the version branch into master

• in the merge commit:

  • change the version in pdi/VERSION by increasing the minor and add the -alpha suffix
  • add an [Unreleased] section at the top of all CHANGELOG.md files

• make a new commit in the version branch (v${X}.${Y})

  • change the version in pdi/VERSION by increasing the patch and add the -alpha suffix

• push all that

Dependency change

When changing the list of dependencies or just the version of one dependency:

• update pdi/docs/Installation.md,
• update PDI distribution CMakeLists.txt as well as all CMakeLists.txt actually using it,
• update the dockerfiles used for tests,
• prepare the update of the spack, deb & RPM packages for the next version.