The migration of pyside6 dependency for scikit-surgeryvtk indicates a major change in the version of the library (2.0.0) as previous releases 1.*.* are related to new features or issues for pyside2 dependency. Hence, I am raising this ticket to track road-map for pre-releases 2.0a1, 2.0.b1, 2.0.rc1 and final release 2.0.0 versions. The following links shows major changes, fixed issues and a list of points for potential release notes.

Major changes

• pyside6 #187
• Debugging unit tests in a systematic-like manner  #203
• Stale branches #201
• adds experimental ci for python-vesrions: 3.9, 3.10, 3.11 and 3.12-dev Encourage the use of pre-release Python 3.12, not 3.11 actions/setup-python#586
• removes py3.7 due to end-of-life on 2023-06-27 https://devguide.python.org/versions/
• updates pylint version Debugging unit tests in a systematic-like manner  #203 (comment)
• updates ci.yml with Qt for X11 Requirements> https://doc.qt.io/qt-6/linux-requirements.html

Fixed issues:

• Fatal Python error: Segmentation faults  #202
• test_set_texture_regression failing on Linux #60
• Remove version specifiers on Pyside2 and VTK #186
• Compatiblility with VTK>8.1.2 and Python 3.8 #165
• Release notes #197
• VTKOverlayWindow does not show up #181
• update tutorial https://github.com/SciKit-Surgery/scikit-surgeryvtk/blob/master/docs/tutorials/overlay_window.ipynb
• Add links for coding guidelines in CONTRIBUTING https://github.com/SciKit-Surgery/scikit-surgeryvtk/blob/master/CONTRIBUTING.rst

What to include in the release notes?

• Summary -- Release highlights
• What's new in scikit-surgeryvtk 2.0.0
• New Features
• Other Bug Fixes
• Other Changes
• Contributors

Some useful references for good release notes

• https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases

Notes

• 16-Feb-2023; 14:00 > Testing tag before doing the pypi release. Steve has used release candidate tag rc1 in PRERELEASE. More on pre-releases https://peps.python.org/pep-0440/#pre-releases and developmental releases https://peps.python.org/pep-0440/#developmental-releases. https://pip.pypa.io/en/stable/cli/pip_install/#pre-release-versions https://py-pkgs.org/07-releasing-versioning.html#
• 2-March-2023 10:15 Stages of development cycle alpha, beta, release candidate and final release https://devguide.python.org/developer-workflow/development-cycle/#devcycle
• On Wed 8 Mar 13:11:28 GMT 2023, added release candidate tag v2.0rc0:

git tag -a 'v2.0rc0' -m "Release candicate version v2.0rc0 using PySide6"
git push origin v2.0rc0 

See v2.0rc0 https://pypi.org/project/scikit-surgeryvtk/2.0rc0/