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 filecreated 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

For a bugfix release, the prepare-release.sh script must be run while you are at the tip of the existing release branch. Otherwise, the script transparently handles the differences in the workflow for bugfix releases, so you should be able to apply the above steps with no change, except for the Wiki update. For a bugfix release such as 20.06.1, we do not create a new wiki page, but reuse the major release page (20.06). So we do not change Releases at all, but update Releases/20.06 as follows:

  1. Change the title from Fast Downward 20.06 to Fast Downward 20.06.1.

  2. Add a line like "Fast Downward 20.06.1 was released on July 33, 2020" below the existing line, leaving the old release date information in place.
  3. Update the source tarball link and upload the new tarball. Don't delete the old tarball, just don't link it from anywhere in the page.
  4. No need to update the Docker / Singularity / Vagrantfile links: we will at all times keep one single version of these releases, the latest in the 20.06.X family.
  5. No need to change the "Referencing Fast Downward 20.06" section.
  6. For the changelog section, keep the section title "Changes in Fast Downward 20.06" and the contents, but add the new entries for the bugfix release. Clearly mark which changes belong to 20.06 and which belong to 20.06.1. See ../ChangelogFormat.

FastDownward: ForDevelopers/ReleaseWorkflow (last edited 2022-06-17 19:26:32 by MalteHelmert)