Skip to content
Paul Sharp edited this page Oct 12, 2026 · 2 revisions

Release checklist

SasView release

Pre-release Tasks

  • Create SasView branch from v6.2.0 release point
  • Include bug fixes from the following:
    • Invariant upgrade part II - PR #4135
    • What’s New cards #4086)
    • magnetism always-on #4072)
    • composite models #4082
    • bumps VarStats.label #4098)
    • Plugin model error — PR #4111
    • ghost polydispersity comboboxes #4110
    • Issues that will not be included
      • #4081 Multiple / batch slicing incompatibilities — no PR - probably leave aside now
      • #3993 Leftover crumbs when renaming a model - potentially covered by #4118
      • #3981 Pinned deps not used for release-branch PR builds
      • #4108 Form-factor plugin docs (pure-Python P(Q))
  • Cherry-pick fixes into branch
  • Update version pins
  • Write the release notes in docs/sphinx-docs/source/user/RELEASE.rst
    • NOTE - Due to the approach of cherry-picking commits from the main branch for this release, rather than using pull requests to the release branch, the automatic release notes could not be generated. These release notes were created using: git log TAGNAME..HEAD --pretty="* %s by @%an". See The auto-generated release notes do not include commits
  • Update release number
    • build_tools/application_metadata/org.sasview.sasview.metainfo.xml - version and release date (line 23)
    • build_tools/release_automation.py - version and title (lines 41 and 42)
    • 'installers/installer.iss' - version number on line 5
  • Check & update lists of developers/contributors in contributors.tsv
  • Mark release manager in contributors.tsv
  • Run python ./sasview/build_tools/release_automation.py with appropriate arguments to generate a zenodo record
  • Update the license and copyright years

Release candidate tasks

  • Create issue to track bugs/issue found while testing the release candidate: #4084

Post-Release Tasks

  • Attach binaries built from tag to release page and zenodo record
  • Upload sasview wheel and tarball to pypi
  • Update https://github.com/flathub/org.sasview.sasview/blob/master/org.sasview.sasview.yml to use latest sasview tag and release date
    • Create new branch, make change and push
    • Open PR to trigger a test build
    • Correct any issues related to the build (typically due to dependencies, deprecations, and incompatibilities)
    • Once build is successful, merge in master to trigger release on flathub
  • Update docs on website
  • Update release link on sasview.org
  • Update latestversion.json
  • Update 'Current Release' link in download.md
  • Create post on website to announce new release
  • Announce release to users@sasview.org (with 'newsletter')
  • Announce release to sa_scat & neutron mailing lists
  • Publish zenodo
  • Merge release branches into main/master for all repositories: https://github.com/SasView/sasview/pull/3895.

Clone this wiki locally