RELEASE.md

Release Guide

To release a new version of the script, the following steps are necessary:

1. Update the Changelog

2. Increase the application version according the Semantic Versioning

   • Update the __version__ in db_sync_tool/info.py
   • Update the "version" in composer.json

3. Generate a new distribution archive (see python.org)

   • Optionally: install the latest version of setuptools and wheel:

   $ python3 -m pip install --user --upgrade setuptools wheel 

   • Generate the archive:

   $ python3 setup.py sdist bdist_wheel 

4. Upload the distribution archive to pypi.org (see python.org)

   • Optionally: install twine for the upload:

   $ python3 -m pip install --user --upgrade twine 

   • Upload the archive:

   $ python3 -m twine upload dist/*

5. Create a new Git Tag with the new version

   $ git tag v1.4

6. Push the commit to the github repository

7. The package is now available via pypi.org and packagist