Release Instructions and Checklist

General

Unless otherwise specified vss-tools follows the VSS release instruction.

VSS-Tools Specifics

Python and Github Actions Dependency Updates

There can be benefits in updating dependencies before each release, some tasks to do:

• Check (detailed) output for GitHub Actions - are there any warnings concerning deprecated functionality (like using an old Node.js)
• As a committer, check the security tab if there are any reported vulnerabilities

Updating Python dependencies

We have two files specifying dependencies, pyproject.toml and uv.lock. The latter is generated from the first. If there is a vulnerability in one of our dependencies a lazy approach is:

• First update the lock file by uv lock -U, if the vulnerability comes from an indirect dependency or is fixed in a patch on the version we use updating the lock file might be sufficient.
• If that did not help, do necessary changes in pyproject.toml and try updating the lock file again.

PyPI

Remember to update PyPI package

Historically VSS and VSS-tools have followed/used the same version numbers and been released/tagged at the same time, but that may change in the future, i.e. it is not certain that VSS X.Y will be compatible with VSS-tools version X.Y