Skip to content

Developer Doc: Creating a New Release

Jeremy Wright edited this page Jan 30, 2023 · 12 revisions

setup.py Changes

Comment out use_scm_version=True and add version="x.y.z", just below it.

init.py Changes

Change the version number in the __init__.py file in the root cadquery directory: __version__ = "x.y-dev" becomes __version__ = "x.y.z"

Update changes.md

All of the changes since the last release need to be documented.

Create a PR

Create a PR for the release changes to give other devs and the broader community the opportunity to comment.

Merge PR

Just what the section title says.

Publish to PyPI

TODO: Add commands here

Change init.py version back to dev

Example: __version__ = "2.2.0" would be become __version__ = "2.3-dev" to start next release cycle.

Change setup.py back to use SCM version

Uncomment use_scm_version=True and remove version="x.y.z", that is just below it.

Clone this wiki locally