Home

DicomFix Wiki

Various notes for development.

Releasing

1. Prepare the Codebase for Release

Make sure all tests are passing and code is ready.

Update any documentation, README, or CHANGELOG as needed.

2. Commit any final updates to main.

git add .
git commit -m "Prepare for version 0.1.1 release"
git push origin main

3. Tag the release in git

git tag -a v0.1.1 -m "Release version 0.1.1"
git push origin v0.1.1

4. Create release on github

Go to your GitHub repository and navigate to the Releases section.

Click Draft a new release.

In Choose a tag, select the tag you just pushed (e.g., v0.1.1).

Add release notes if desired and publish the release.

5. Check

After tagging, setuptools_scm will include the Git hash in your version, which you can check by running:

python dicomfix/main.py -V
dicomfix 0.1.1-gabcdef

6. In case of not post-release versioning scheme but guess-next-dev

Once the release is tagged, you may want to increment the version for development. For example, if you just released 0.1.1, update to 0.1.2.dev0 by adding a line in pyproject.toml or by tagging v0.1.2.