Skip to content

Latest commit

 

History

History
8 lines (8 loc) · 882 Bytes

release_process.md

File metadata and controls

8 lines (8 loc) · 882 Bytes
Raw

Release Process

To create a release there are a few steps you should follow:

  • We use Semantic Versioning. If you're going to release a breaking change or a major new feature, do a minor version bump (x.y.z => x.y+1.z). Otherwise, do a patch version bump (x.y.z => x.y.z+1).
  • If you decide to do a minor version change, handle deprecations. See (Pending)DeprecationWarning subclasses in error.py.
  • Update the version number in version.py and push this to master.
  • Create a new tag with the new version number in the following way: git tag <major.minor.patch>.
  • Push the tag by using git push --tags.
  • The release process in Github Actions will create a package on PYPI and a draft release on GitHub. Edit the draft release, type a summary of all changes and remove the draft status.