Release ParaView 5.9.0-RC1
Preparatory steps
- Update ParaView guides
- User manual
-
Rename to ParaViewGuide-5.9.0.pdf -
Upload to www.paraview.org/files/v5.9
-
- Catalyst Guide
-
Rename to ParaViewCatalystGuide-5.9.0.pdf -
Upload to www.paraview.org/files/v5.9
-
- Getting Started Guide
-
Rename to ParaViewGettingStarted-5.9.0.pdf -
Upload to www.paraview.org/files/v5.9
-
- Assemble release notes into
Documentation/release/ParaView-5.9.0
.-
Get positive review and merge.
-
- User manual
Update ParaView
-
Update master
branch for paraview
git fetch origin
git checkout master
git merge --ff-only origin/master
git submodule update --recursive --init
-
Update version.txt
and tag the commit
git checkout -b update-to-v5.9.0-RC1
echo 5.9.0-RC1 > version.txt
git commit -m 'Update version number to 5.9.0-RC1' version.txt
git tag -a -m 'ParaView 5.9.0-RC1' v5.9.0-RC1 HEAD
- Integrate changes to
master
branch-
Create a merge request targeting master
(do not addBackport: release
) -
Do: merge
-
- Update VTK's
paraview/release
branch-
Change directory to VTK source -
git push origin <paraview-vtk-submodule-hash>:paraview/release
-
Update kwrobot with the new paraview/release
branch rules
-
- Integrate changes to
release
branch-
Change directory to ParaView source. Stay on the update-to-v5.9.0-RC1
branch. -
git config -f .gitmodules submodule.VTK.branch paraview/release
-
git commit -m "release: follow VTK's paraview/release branch" .gitmodules
-
Merge new release
branch intomaster
using-s ours
git checkout master
git merge --no-ff -s ours -m "Merge branch 'release'" update-to-v5.9.0-RC1
-
git push origin master update-to-v5.9.0-RC1:release
-
Update kwrobot with the new release
branch rules
-
- Create tarballs
-
ParaView ( Utilities/Maintenance/create_tarballs.bash --txz --tgz --zip -v v5.9.0-RC1
)
-
- Upload tarballs to
paraview.org
-
rsync -rptv $tarballs paraview.release:ParaView_Release/v5.9/
-
Update ParaView-Superbuild
-
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.9.0-RC1
- 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.9.0-RC1" CACHE STRING "Force version to 5.9.0-RC1" 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/development/Dockerfile
)-
ARG PARAVIEW_TAG=v5.9.0-RC1 -
ARG SUPERBUILD_TAG=v5.9.0-RC1
-
-
Commit changes and push to GitLab
-
git add versions.cmake CMakeLists.txt Scripts/docker/ubuntu/development/Dockerfile
git commit -m "Update the default version to 5.9.0-RC1"
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 --no-edit
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.9.0-RC1' v5.9.0-RC1 HEAD
-
- Integrate changes to
release
branch-
git push origin update-to-v5.9.0-RC1:release
-
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.9.0-RC1.app/
-
Install from .dmg and verify that it is signed with codesign -dvvv /Applications/ParaView-5.9.0-RC1.app/
Validating binaries
For each binary, open the Python shell and run the following:
import numpy
s = Show(Sphere())
ColorBy(s, ('POINTS', 'Normals', 'X'))
Show(Text(Text="$A^2$"))
Check that
- Getting started guide opens
- Examples load and match thumbnails in dialog
- Python. Open the Python shell and run
- Plugins are present and load properly
- 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.9/
) -
Ask @utkarsh.ayachit to regenerate https://www.paraview.org/files/listing.txt
andmd5sum.txt
on the website
buildListing.sh
updateMD5sum.sh v5.9
-
Test download links on https://www.paraview.org/download
Push tags
-
In the paraview
repository, rungit push origin v5.9.0-RC1
. -
In the paraview-superbuild
repository, rungit push origin v5.9.0-RC1
.
Post-release
-
Post an announcement in the Announcements category on discourse.paraview.org.
/cc @ben.boeckel /cc @cory.quammen /cc @utkarsh.ayachit