GitLab

Preparatory steps

• Update ParaView guides
  • User manual
    • Rename to ParaViewGuide-5.6.0-RC2.pdf
    • Upload to www.paraview.org/files/v5.6
  • Catalyst Guide
    • Rename to ParaViewCatalystGuide-5.6.0-RC2.pdf
    • Upload to www.paraview.org/files/v5.6
  • Getting Started Guide
    • Rename to ParaViewGettingStarted-5.6.0-RC2.pdf
    • Upload to www.paraview.org/files/v5.6
  • Assemble release notes into Documentation/release/ParaView-5.6.0-RC2.
    • Get positive review and merge.

Update ParaView

If making a release from the release branch, e.g., v5.6.0-RC2 or above:

• Update release branch for paraview

git fetch origin
git checkout release
git merge --ff-only origin/release

• Update version.txt and tag the commit

git checkout -b update-to-v5.6.0-RC2
echo 5.6.0-RC2 > version.txt
git commit -m 'Update version number to 5.6.0-RC2' version.txt
git tag -a -m 'ParaView 5.6.0-RC2' v5.6.0-RC2 HEAD

• Integrate changes to master branch
  • Create a merge request targeting master (do not add Backport: release)
  • Get positive review
  • Do: merge
• Integrate changes to release branch
  • git push origin update-to-v5.6.0-RC2:release v5.6.0-RC2
• Create tarballs
  • ParaView (Utilities/Maintenance/create_tarballs.bash --txz --zip -v v5.6.0-RC2)
  • Catalyst (Catalyst/generate-tarballs.sh v5.6.0-RC2)
• Upload tarballs to paraview.org
  • rsync -rptv $tarballs paraview.release:ParaView_Release/v5.6/

Update ParaView-Superbuild

If making a release from the release branch, e.g., v5.6.0-RC2 or above:

• Update release branch for paraview/paraview-superbuild

git fetch origin
git checkout release
git merge --ff-only origin/release

• Update CMakeLists.txt
  • git checkout -b update-to-v5.6.0-RC2
  • Set ParaView source selections in CMakeLists.txt and force explicit version in CMakeLists.txt:

# Force source selection setting here.
set(paraview_SOURCE_SELECTION "5.6.0-RC2" CACHE STRING "Force version to 5.6.0-RC2" FORCE)
set(paraview_FROM_SOURCE_DIR OFF CACHE BOOL "Force source dir off" FORCE)

• Update versions.cmake

  • Guide selections in versions.cmake
  • git add versions.cmake CMakeLists.txt
  • git commit -m "Update the default version to 5.6.0-RC2"

• Integrate changes to master branch

  • Create a merge request targeting master, title beginning with WIP
  • Build binaries (Do: test)
  • Download the binaries that have been generated in the dashboard results. They will be deleted within 24 hours.
  • Remove explicit version forcing added in CMakeLists.txt and force push

git add CMakeLists.txt
git commit --amend
git gitlab-push -f

• Finish merge request
  • Remove WIP from merge request title
  • Get positive review
  • Do: merge
  • git tag -a -m 'ParaView superbuild 5.6.0-RC2' v5.6.0-RC2 HEAD
• Integrate changes to release branch
  • git push origin update-to-v5.6.0-RC2:release v5.6.0-RC2

Validating binaries

• For each binary, check

  • Getting started guide opens
  • Examples load and match thumbnails in dialog
  • Python
  • import numpy
  • Plugins are present and load properly
  • Text source LaTeX $A^2$
  • OSPRay
  • IndeX runs
  • AutoMPI

• Binary checklist

  • macOS
  • Linux
  • Windows MPI (.exe)
  • Windows MPI (.zip)
  • Windows no-MPI (.exe)
  • Windows no-MPI (.zip)

Upload binaries

• Upload binaries to paraview.org
  • rsync -rptv $binaries paraview.release:ParaView_Release/v5.6/
• Ask @chuck.atkins to sign macOS binary
• Ask @utkarsh.ayachit to regenerate https://www.paraview.org/files/listing.txt and md5sum.txt

buildListing.sh
updateMD5sum.sh v5.6

• Test download links

Post-release

• Write and publish blog post with release notes.
• Post an announcement in the Announcements category on discourse.paraview.org.

/cc @ben.boeckel /cc @cory.quammen /cc @utkarsh.ayachit