release.md

name	Create Release
about	Create a new release of the AI Lab
title	📦 Create Release <version>
labels	task
assignees

• Adjust version number in file pyproject.toml

If you decided to change the version number then

• Run poetry run -- version-check <path/version.py> --fix (only when using PTB)
• Rename latest file doc/changes/changes_*.md accordingly
• Update reference in file doc/changes/changelog.md
• Update version number in latest file doc/changes/changes_*.md

Always

• latest file doc/changes/changes_*.md
  • Append release date to first line
  • Add a code name and a summary
• Update version number
  • user_guide/docker/docker-usage.md
  • user_guide/vm-edition/win-vbox.md
  • developer_guide/testing.md
• Replace dependencies to unreleased version (e.g. git dependencies) in files, see instructions in notebooks.md:
  • notebook_requirements.txt
  • jupyter_requirements.txt
  • pyproject.toml

Ship the Actual Release

• Ensure PR CI completed the Check Version Number step in .github/workflows/ci.yaml successfully
• Merge the release PR
• Push the release version tag
• Verify the Release workflow published the AWS and Docker artifacts for that tag

Post-Release Actions

• Update links in file README.md to point to the tag on GitHub