Back to developer page.

Release Workflow

Assuming we want to create the 20.06 release, these are the steps we would follow:

  1. Make sure that all Github actions are green.
  2. Make sure that you are on the revision you want to release.
  3. Make sure that the list of contributors and copyright years in the README.md file are up to date.

  4. Make sure the changelog (see ../ChangelogFormat) is up to date and committed. In particular:

    1. Make sure the changelog includes the line giving the date of the release.
    2. Replace the section title ## Changes since the last release with something like ## Fast Downward 20.06.

  5. Make sure that the working directory is clean and that any last-minute changes done following the above steps are commited.
  6. Update version number and create branches, tags and recipe files by running the prepare-release.sh script.

    • ./misc/releases/prepare-release.sh 20.06.0
  7. Verify the following manually:
    1. The fast-downward-20.06.0.tar.gz tarball created in the previous step contains the appropriate files.

    2. Branches and tags were created as expected.
    3. A new commit was created with the right recipe files and version changes.
  8. Push all changes.
    • git push --all
      git push --tags
  9. Build the Docker image and push it to the Docker Hub. Note that we build the 20.06 Docker image, not 20.06.0. Under normal conditions, Docker needs root rights, and the script needs an environment variable that points to a directory containing the SoPlex archive in the correct version. The actual push to Docker hub needs appropriate credentials. Malte has them; not sure anyone else does. (Please edit if you do.)

    • sudo DOWNWARD_LP_INSTALLERS=/path/to/dir/with/installer/ ./misc/releases/push-docker.sh 20.06
  10. Build the Apptainer (successor to Singularity) image:
    • sudo apptainer build fast-downward.sif misc/releases/20.06/Singularity.20.06

    Note: Ubuntu (*.deb) packages for Apptainer are available here: https://github.com/apptainer/apptainer/releases. Tested with Apptainer 1.0.2.
    Note: From what I understand, Apptainer doesn't actually need the recipe files that we build any more, and one could just build directly from the docker image. If someone is interested in getting rid of the recipes and modernizing the process, please speak to Malte and Florian (unless you're Malte or Florian ;-)). For now, I've left things as they are because it worked.

  11. Test, at minimum:
    • that we can build and successfully run the planner from the produced tarball
    • that we can successfully run the planner from the produced Apptainer image, including a configuration using Soplex
    • that we can successfully run the planner from the produced Vagrantfile
  12. Add a new empty section ## Changes since the last release to the changelog to prepare the changelog section for the next release. Commit and push.

  13. Create a Wiki page for the release. We suggest starting from a copy of the page for the last release.

    1. Update the date and release version name.
    2. Update the changelog.
    3. Upload the tarball as an attachment to the page.
    4. Upload the Vagrant file created by the prepare-release.sh script as an attachment to the page.

    5. Upload the fast-downward.sif Apptainer image as an attachment to the page.

    6. Create a link in Releases to the page of the new release.

    7. Make sure the necessary acknowledgements and links are included for SoPlex.

  14. Create a new release on github:
    1. On https://github.com/aibasel/downward/releases click on "Draft new release"

    2. Set Tag to release-20.06.0, Release Title to 20.06, and Description to For information about this release, please visit the [Fast Downward wiki](https://www.fast-downward.org/Releases/20.06).

    3. Click on Publish Release

  15. Send an announcement e-mail to the Fast Downward list including changelog information.

Bugfix Releases

The bugfix release workflow is a little different than the workflow for a new release, but it also has a lot in common. The major difference comes from the fact that you need to manually select the issues / fixes that you want to include in (and hence also those that you want to exclude from) the bugfix release. For simplicity of reuse, we repeat all steps here. All provided commands use bugfix 22.06.1 for release 22.06, replace this accordingly for your bugfix release.

  1. Start by checking out the release branch
    • git checkout release-22.06
  2. For all issue branches that you want to include in the bugfix release, repeat the following steps, starting with the branch that was merged into main the earliest:
    1. cherry-pick the merge commit with hash HASH of the issue branch XXXX with
      • git cherry-pick HASH -m 1
    2. fix any merge conflicts that might arise (if any merged branches are excluded from the bugfix release, this will likely happen for the first branch in CHANGES.md)
    3. commit changes on release branch
      • git commit -m "[release-22.06] Cherry-picked issueXXXX"
  3. Make sure that the list of contributors and copyright years in the README.md file are up to date.

  4. Make sure the changelog (see ../ChangelogFormat) is up to date and committed. In particular:

    1. Make sure the changelog includes the line giving the date of the bugfix release.
    2. Replace the section title ## Changes since the last release with something like ## Fast Downward 22.06.1.

  5. Make sure that the working directory is clean and that any last-minute changes done following the above steps are commited.
  6. Update version number and create branches, tags and recipe files by running the prepare-release.sh script.

    • ./misc/releases/prepare-release.sh 22.06.1
  7. Verify the following manually:
    1. The fast-downward-22.06.1.tar.gz tarball created in the previous step contains the appropriate files.

    2. A tag like 22.06.1 was created on the existing release branch 22.06

    3. A new commit was created with the right recipe files and version changes.
  8. Push all changes.
    • git push --all
      git push --tags
  9. Make sure that all Github actions are green. Note that this step comes much later than in the release workflow because you pushed a version of the planner that did not necessarily exist in the repo before (because some commits might have been excluded).
  10. Build the Docker image and push it to the Docker Hub. Note that we build the 20.06 Docker image, not 20.06.0. Under normal conditions, Docker needs root rights, and the script needs an environment variable that points to a directory containing the SoPlex archive in the correct version. The actual push to Docker hub needs appropriate credentials. Malte has them; not sure anyone else does. (Please edit if you do.)

    • sudo DOWNWARD_LP_INSTALLERS=/path/to/dir/with/installer/ ./misc/releases/push-docker.sh 20.06
  11. Build the Apptainer (successor to Singularity) image:
    • sudo apptainer build fast-downward.sif misc/releases/20.06/Singularity.20.06

    Note: Ubuntu (*.deb) packages for Apptainer are available here: https://github.com/apptainer/apptainer/releases. Tested with Apptainer 1.0.2.
    Note: From what I understand, Apptainer doesn't actually need the recipe files that we build any more, and one could just build directly from the docker image. If someone is interested in getting rid of the recipes and modernizing the process, please speak to Malte and Florian (unless you're Malte or Florian ;-)). For now, I've left things as they are because it worked.

  12. Test, at minimum:
    • that we can build and successfully run the planner from the produced tarball
    • that we can successfully run the planner from the produced Apptainer image, including a configuration using Soplex
    • that we can successfully run the planner from the produced Vagrantfile
  13. Update the Wiki page of the release (for a bugfix release such as 22.06.1, we do not create a new wiki page, but reuse the major release page 22.06). See the updated Wiki page for [release 22.06](https://www.fast-downward.org/Releases/22.06) for an example.

    1. Adjust the date and mention the bugfix release version name.
    2. Update the changelog.
    3. Update the name of the tarball (it should include the bugfix number) and upload the tarball as an attachment to the page.
    4. Upload the Vagrant file created by the prepare-release.sh script as an attachment to the page.
    5. Upload the fast-downward.sif Apptainer image as an attachment to the page.
  14. Create a new release on github:
    1. On https://github.com/aibasel/downward/releases click on "Draft new release"

    2. Set Tag to release-22.06.1, Release Title to 22.06.1, and Description to For information about this release, please visit the [Fast Downward wiki](https://www.fast-downward.org/Releases/22.06).

    3. Click on Publish Release

  15. Send an announcement e-mail to the Fast Downward list including changelog information.

FastDownward: ForDevelopers/ReleaseWorkflow (last edited 2022-09-22 09:24:17 by ThomasKeller)