Skip to content

GitLab

Last edited by Oliver Kirsebom
Page history

Merging a patch

  • Major version update (1.0 -> 2.0) when including significantly new functionality, where changes are not compatible with previous versions
  • Minor version update (1.0 -> 1.1) when adding new functionality that remain backwards compatible
  • Patch version update (1.0 -> 1.0.1) when adding patches that remain backwards compatible

Steps required to merge a version update

  1. Make sure all unit tests and doc tests are passing
  2. Update the change log, docs conf, and version number (docs/source/versions/changelog.rst, setup.py, docs/source/conf.py)
  3. If any new features change how the software is used, update, build, and upload the documentation to the server:
cd docs/
./build_and_upload_docs.sh

  1. create merge request to master branch

  2. Once this request is merged, upload the new version to PyPI:

python setup.py sdist bdist_wheel
twine upload dist/kadlu-X.Y.Z.tar.gz