Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
ParaView
ParaView
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1,777
    • Issues 1,777
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 66
    • Merge Requests 66
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • ParaView
  • ParaViewParaView
  • Issues
  • #20446

Closed
Open
Opened Jan 22, 2021 by Vicente Bolea@vbolea💬Maintainer60 of 60 tasks completed60/60 tasks

Release Paraview 5.9.0

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.

Update ParaView

  • 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.9.0
echo 5.9.0 > version.txt
git commit -m 'Update version number to 5.9.0' version.txt
git tag -a -m 'ParaView 5.9.0' v5.9.0 HEAD
  • Integrate changes to master branch
    • Create a merge request targeting master (do not add Backport: release)
    • Do: merge
  • Integrate changes to release branch (push the update-to-v@version@ branch to be the new release branch)
    • git push origin update-to-v5.9.0:release
  • Create tarballs
    • ParaView (Utilities/Maintenance/create_tarballs.bash --txz --tgz --zip -v v5.9.0)
  • Upload tarballs to paraview.org
    • rsync -rptv $tarballs user@host: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 --recursive --init
git checkout -b update-to-v5.9.0
  • Update CMakeLists.txt
    • Update PARAVIEW_VERSION_DEFAULT to the release version (without RC*)
    • Set ParaView source selections in CMakeLists.txt and force explicit version in CMakeLists.txt:
# Force source selection setting here.
set(paraview_SOURCE_SELECTION "5.9.0" CACHE STRING "Force version to 5.9.0" FORCE)
set(paraview_FROM_SOURCE_DIR OFF CACHE BOOL "Force source dir off" FORCE)
  • Update versions
    • Guide selections in versions.cmake
    • paraview_SOURCE_SELECTION version in README.md
    • Docker: update default tag strings (in Scripts/docker/ubuntu/development/Dockerfile)
      • ARG PARAVIEW_TAG=v5.9.0
      • ARG SUPERBUILD_TAG=v5.9.0
      • ARG PARAVIEW_VERSION_STRING=paraview-5.9
    • 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"
git gitlab-push
  • Integrate changes to master branch
    • Create a merge request targeting master, title beginning with WIP (do not add Backport: release to description)
    • Build binaries (start all pipelines)
    • Download the binaries that have been generated from the Pipeline build products. 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 --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' v5.9.0 HEAD
  • Integrate changes to release branch
    • git push origin update-to-v5.9.0: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.app/
  • Install from .dmg and verify that it is signed with codesign -dvvv /Applications/ParaView-5.9.0.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 and md5sum.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, run git push origin v5.9.0.
  • In the paraview-superbuild repository, run git push origin v5.9.0.

Spack

  • Update Spack package: https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/paraview/package.py

Update documentation

  • Upload versioned documentation to https://github.com/kitware/paraview-docs (see https://github.com/Kitware/paraview-docs/blob/master/README.md)
  • Tag the ParaView docs with v5.9.0.
  • Activate the tag on readthedocs and build it here
  • Go to readthedocs.org and activate
  • Write and publish blog post with release notes.
  • Update release notes (https://www.paraview.org/Wiki/ParaView_Release_Notes)

Post-release

  • Post an announcement in the Announcements category on discourse.paraview.org.
  • Request DoD vulnerability scan
  • Request update of version number in "Download Latest Release" text on www.paraview.org
  • Request update of link to ParaView Guide PDF at https://www.paraview.org/paraview-guide/
  • Move unclosed issues to next release milestone in GitLab

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

Edited Jan 28, 2021 by Cory Quammen
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: paraview/paraview#20446