Release ChecklistΒΆ

Pre-release PreparationsΒΆ

  • Update version number in pyproject.toml and docs/source/conf.py files.

  • Update CHANGELOG.md with new features, fixes, and improvements.

  • Review pyproject.toml - Update dependencies if needed. - Pin versions for production stability in uv.lock

  • Update documentation (README.md, API docs, usage instructions) for new features.

  • Ensure all new migrations are created, committed, tested locally

ReleaseΒΆ

  • GitHub Workflow Checks - Code coverage threshold maintained ( >85%). - Docker build passes. - All feature test pass - All unit test pass - Read the docs build passes - SBOM generation passes - Code linter (ruff and mypy) tests pass - No new deprecations from Django or libraries in test logs.

  • Create git tag for release

Post-ReleaseΒΆ

  • Trustpoint Docker Hub Account - Tag the docker image with release tag and push to the Docker Hub - Update the README.md on the Docker Hub if required

  • Update Trustpoint website with release information.