Publication of Galaxy Release v 24.2

[jdavcs]

• Branch Release (on or around 2024-11-20)

  • Verify that your installed version of galaxy-release-util is up-to-date.

  • Ensure all blocking milestone pull requests have been merged, closed, or postponed until the next release.

    galaxy-release-util check-blocking-prs 24.2 --release-date 2025-01-15
    

  • Add latest database revision identifier (for release_24.2 and 24.2) to REVISION_TAGS in galaxy/model/migrations/dbscript.py.

  • Merge the latest release into dev and push upstream.

    make release-merge-stable-to-next RELEASE_PREVIOUS=release_24.1
    make release-push-dev
    

  • Create and push release branch:

    make release-create-rc
    

  • Open pull requests from your fork of branch version-24.2 to upstream release_24.2 and of version-25.0.dev to dev.

  • Create milestone 25.0 for next release.

  • Update MILESTONE_NUMBER in the maintenance bot to reference 25.0 so it properly tags new pull requests.

• Issue Review Timeline Notes

  • Ensure any security fixes will be ready prior to 2024-11-20 + 1 week, to allow time for notification prior to release.
  • Ensure ownership of outstanding bugfixes and track progress during freeze.

• Deploy and Test Release on galaxy-test

  • Update test.galaxyproject.org to ensure it is running the release_24.2 branch.
  • Update testtoolshed.g2.bx.psu.edu to ensure it is running a dev at or past branch point (2024-11-20 + 1 day).
  • Conduct formal release testing on test.galaxyproject.org (see 24.2 release testing plan).
  • Ensure all critical bugs detected during release testing have been fixed.

• Run tool and workflow tests:

  • IUC:

    • Open an issue "Test release 24.2" on the iuc repo: https://github.com/galaxyproject/tools-iuc/
    • Post this comment to that issue: /run-all-tool-tests branch=release_24.2. This will trigger the "Weekly global Tool Linting and Tests" github workflow that lints and tests all IUC tools.
    • Wait for the workflow to complete, after which a brief summary will be automatically posted to the issue with a link to the workflow results.
    • Examine workflow results, comparing them with the results of a previous run of the same workflow on the previous release (24.1).
      For each failed test:
      - Does it occur under 24.2 but not under 24.1? If so:
      - Check if there's an issue open. If not, open a new issue.

  • IWC:

    • Open an issue "Test release 24.2" on the iwc repo: https://github.com/galaxyproject/iwc/
    • Post this comment to that issue: /run-all-workflow-tests branch=release_24.2. This will trigger the "Weekly global Workflow Linting and Tests" github workflow that lints and tests all IWC workflows.
    • Wait for the workflow to complete, after which a brief summary will be automatically posted to the issue with a link to the workflow results.
    • Examine workflow results, comparing them with the results of a previous run of the same workflow on the previous release (24.1).
      For each failed test:
      - Does it occur under 24.2 but not under 24.1? If so:
      - Check if there's an issue open. If not, open a new issue.

• Create Release Notes

  • Review pull requests merged since release_24.1, ensure their titles are properly formatted and they all have a 24.2 or 25.0 milestone attached. Link

  • Switch to release branch and create a new branch for release notes

    git checkout release_24.2 -b 24.2_release_notes
    

  • Bootstrap the release notes

    galaxy-release-util create-changelog 24.2 --release-date 2025-01-15 --next-version 25.0
    

  • Open newly created files and manually curate major topics and release notes.

  • Run python scripts/release-diff.py release_24.1 and add configuration changes to release notes.

  • Add new release to doc/source/releases/index.rst

  • Open a pull request for the release notes branch.

  • Merge release notes pull request.

• Deploy and Test Release on galaxy-main

  • Update usegalaxy.org to ensure it is running the release_24.2 branch.
  • Deploy to toolshed.g2.bx.psu.edu.
  • Conduct second stage of release testing on usegalaxy.org.
  • Update BioBlend CI testing to include a release_24.2 target: add - release_24.2 to the galaxy_version list in .github/workflows/test.yaml .
  • Update GALAXY_RELEASE in IUC and devteam github workflows
    • https://github.com/galaxyproject/tools-iuc/blob/master/.github/workflows/
    • https://github.com/galaxyproject/tools-devteam/blob/master/.github/workflows/

• Do Release

  • Ensure all blocking milestone issues have been resolved.

    galaxy-release-util check-blocking-issues 24.2
    

  • Ensure all blocking milestone pull requests have been merged, closed, or postponed until the next release.

    galaxy-release-util check-blocking-prs 24.2 --release-date 2025-01-15
    

  • Ensure all pull requests merged into the pre-release branch during the freeze have milestones attached

  • Ensure all pull requests merged into the pre-release branch during the freeze are the not 25.0 milestones

  • Ensure there are no blocking pull requests that target the release_24.2 branch but do not have the 24.2 milestone attached.

  • Ensure release notes include all pull requests added during the freeze by re-running the release note bootstrapping:

    galaxy-release-util create-changelog 24.2 --release-date 2025-01-15 --next-version 25.0
    

  • Ensure previous release is merged into current. GitHub branch comparison

  • Create and push release tag:

    make release-create
    

  • Create the first point release (v24.2.0) using the instructions at https://docs.galaxyproject.org/en/master/dev/create_release.html#creating-galaxy-point-releases

  • Open PR against planemo with a pin to the new packages

• Announce Release

  • Verify release included in https://docs.galaxyproject.org/en/master/releases/index.html.
  • Review announcement in https://github.com/galaxyproject/galaxy/blob/dev/doc/source/releases/24.2_announce.rst.
  • Announce release on Galaxy Hub as a news content item. An example.
  • Post announcement to Galaxy Help. An example.
  • Announce release on Galaxy's social media accounts (Bluesky, Mastodon, LinkedIn).
  • Email announcement to galaxy-dev and galaxy-announce @lists.galaxyproject.org. An example.
  • Adjust http://getgalaxy.org text and links to match current master branch by opening a PR at https://github.com/galaxyproject/galaxy-hub/

• Complele release

  • Close milestone 24.2 and ensure milestone 25.0 exists.
  • Close this issue.