Release procedure (permanent issue)

Manual checks:

• Browse through entire online documentation: all scripts and figures present?
• Check all links in documentation (#1134 (closed))

Release new versions of dependencies, if they have changed:

• libheinz
• libformfactor

Manual deployment tests (check installation procedures according to webdocs; run Python scripts, run GUI session; import sample from script to GUI)

• Debian
• Mac10
• Mac12
• Windows

Finalize bornagain (MRs against release branch):

• Finalize CHANGELOG
• Write release letter
• CMakeLists.txt
• In hugo/config.toml, update release_number, version_name, url_blob
• Set git tag vx.y - reversible freeze

Finalize ba-www (in fresh release branch):

• Update content/documentation.md
• Update static/js/version_switch
• In config.toml, update version_mm
• Add release letter

Upload installers and wheels (this makes the release irreversible):

• Build installers and wheels for all Python versions
• Installers to www@scgbuild:www/ext/ba/files/version.patch/
• Wheels to PyPI

Publish:

• Create release in Jugit
• In www@scg3:ba: for hotfix, update versioned repository (in subdirectory repo, checkout release branch and run make, make figures etc, hugo); for major release, create new versioned repository
• In www@scg3:www/ba/public, update latest and version link
• Merge release branch to ba-www => Docs will automatically be updated

Inform users

• Mail to BornAgain mailing list
• For major milestones, mail to external mailing lists (neutron, sa_scat [unsigned mails only!])
• Update "Latest" section on computing.mlz-garching.de
• Inform Debian maintainers

Create next release branch

• Create branch rx.y, push to Jugit
• In Jugit > Settings > Repository > Protected Branches, protect the branch

added META label

mentioned in issue #340 (closed)

changed the description

changed the description

changed the description

changed the description

changed the description

changed the description

marked the checklist item In BornAgain-www, update content/documentation.md and static/js/version_switch.js as completed

changed the description

changed the description

changed the description

changed the description

changed the description

mentioned in issue #547 (closed)

marked the checklist item Debian as completed

marked the checklist item Mac10 as completed

marked the checklist item Mac12 as completed

marked the checklist item Windows as completed

marked the checklist item Change log as completed

marked the checklist item Release letter as completed

changed the description

changed the description

marked the checklist item libformfactor as completed

marked the checklist item In release branch, in hugo/config.toml, update baseURL, release_number and version_name to use x.y as incomplete

marked the checklist item Port changes back to main: In hugo/config.toml, revert baseURL and version_name (but not release_number) to git-main. as incomplete

marked the checklist item In release branch, run the following: (cd build; make figures); cp -prf Examples hugo/static/py/auto/; hugo; cp -pr public /v-public/x.y as incomplete

marked the checklist item In BornAgain-www, add and commit new subdirectory of v-public. as incomplete

marked the checklist item In BornAgain-www, update content/documentation.md (mark new release as "forthcoming") and static/js/version_switch.js as incomplete

marked the checklist item In BornAgain-www/config.toml, update url_latest. as incomplete

marked the checklist item Update version links in .gitlab-ci.yml. This should be done immediately after changing variable latest_release in /static/js/version_switch.js, lest cross-version links become inconsistent. as incomplete

marked the checklist item libheinz as incomplete

marked the checklist item libformfactor as incomplete

marked the checklist item Last updates to CHANGELOG as incomplete

marked the checklist item Create branch rx.y, push to Jugit as incomplete

marked the checklist item In Jugit > Settings > Repository > Protected Branches, protect the branch as incomplete

marked the checklist item In release branch, set new version number as incomplete

marked the checklist item Debian as incomplete

marked the checklist item Mac10 as incomplete

marked the checklist item Mac12 as incomplete

marked the checklist item Windows as incomplete

changed the description

changed the description