Release ParaView 5.8.0-RC3
Preparatory steps
- Update ParaView guides
- User manual
-
Rename to ParaViewGuide-5.8.0.pdf -
Upload to www.paraview.org/files/v5.8
-
- Catalyst Guide
-
Rename to ParaViewCatalystGuide-5.8.0.pdf -
Upload to www.paraview.org/files/v5.8
-
- Getting Started Guide
-
Rename to ParaViewGettingStarted-5.8.0.pdf -
Upload to www.paraview.org/files/v5.8
-
- Assemble release notes into
Documentation/release/ParaView-5.8.0
.-
Get positive review and merge.
-
- User manual
Update ParaView
If making a release from the release
branch, e.g., v5.8.0-RC2 or above
:
-
Update release
branch for paraview
git fetch origin
git checkout release
git merge --ff-only origin/release
git submodule update --recursive --init
-
Update version.txt
and tag the commit
git checkout -b update-to-v5.8.0-RC3
echo 5.8.0-RC3 > version.txt
git commit -m 'Update version number to 5.8.0-RC3' version.txt
git tag -a -m 'ParaView 5.8.0-RC3' v5.8.0-RC3 HEAD
-
Integrate changes to
master
branch-
Create a merge request targeting master
(do not addBackport: release
) -
Get positive review -
Do: merge
-
-
Integrate changes to
release
branch-
git push origin update-to-v5.8.0-RC3:release v5.8.0-RC3
-
-
Create tarballs
-
ParaView ( Utilities/Maintenance/create_tarballs.bash --txz --tgz --zip -v v5.8.0-RC3
)
-
-
Upload tarballs to
paraview.org
-
rsync -rptv $tarballs paraview.release:ParaView_Release/v5.8/
-
Update ParaView-Superbuild
If making a release from the release
branch, e.g., v5.8.0-RC2 or above
:
-
Update release
branch for paraview/paraview-superbuild
git fetch origin
git checkout release
git merge --ff-only origin/release
git submodule update
git checkout -b update-to-v5.8.0-RC3
- Update
CMakeLists.txt
-
Set ParaView source selections in CMakeLists.txt
and force explicit version inCMakeLists.txt
:
-
# Force source selection setting here.
set(paraview_SOURCE_SELECTION "5.8.0-RC3" CACHE STRING "Force version to 5.8.0-RC3" FORCE)
set(paraview_FROM_SOURCE_DIR OFF CACHE BOOL "Force source dir off" FORCE)
- Update versions
-
Guide selections in versions.cmake
-
Docker: update default tag strings (in Scripts/docker/ubuntu/Dockerfile
)-
ARG PARAVIEW_TAG=v5.8.0-RC3 -
ARG SUPERBUILD_TAG=v5.8.0-RC3
-
-
Commit changes and push to GitLab
-
git add versions.cmake CMakeLists.txt Scripts/docker/ubuntu/Dockerfile
git commit -m "Update the default version to 5.8.0-RC3"
git gitlab-push
- Integrate changes to
master
branch-
Create a merge request targeting master
, title beginning with WIP (do not addBackport: release
to description) -
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, amend the commit, and force push
-
git add CMakeLists.txt
git commit --amend
git gitlab-push -f
- Finalize merge request
-
Remove WIP from merge request title -
Get positive review -
Do: merge
-
git tag -a -m 'ParaView superbuild 5.8.0-RC3' v5.8.0-RC3 HEAD
-
- Integrate changes to
release
branch-
git push origin update-to-v5.8.0-RC3:release v5.8.0-RC3
-
Sign macOS binaries
-
Upload to signing server, run script, download resulting .pkg and .dmg files -
Install from .pkg and verify that it is signed with codesign -dvvv /Applications/ParaView-5.8.0-RC3.app/
-
Install from .dmg and verify that it is signed with codesign -dvvv /Applications/ParaView-5.8.0-RC3.app/
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 raycasting and pathtracing runs -
OptiX pathtracing runs -
IndeX runs -
AutoMPI
-
-
Binary checklist
-
macOS -
Linux -
Linux osmesa -
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.8/
) -
Ask @utkarsh.ayachit to regenerate https://www.paraview.org/files/listing.txt
andmd5sum.txt
on the website
buildListing.sh
updateMD5sum.sh v5.8
-
Test download links on https://www.paraview.org/download
Post-release
-
Post an announcement in the Announcements category on discourse.paraview.org.
/cc @ben.boeckel /cc @cory.quammen /cc @utkarsh.ayachit