Release.md

How to release

This is documenting the release process.

Git flow & CHANGELOG.md

Make sure the CHANGELOG.md is up to date and follows the http://keepachangelog.com guidelines. Start the release with git flow:

git flow release start vYYYY.MMDD

Now update the CHANGELOG.md [Unreleased] section to match the new release version. Also update the __version__ and __version_code__ values from the version.py file. Optionally already update the direct download link from the README.md. Then commit and finish release.

git commit -a -m "vYYYY.MMDD"
git flow release finish

Push everything, make sure tags are also pushed:

git push
git push origin master:master
git push --tags

PyPI

We also publish the desktop app to PyPI on https://pypi.org/project/EtherollApp/ via:

make release/build
make release/upload

GitHub

Got to GitHub Release/Tags, click "Add release notes" for the tag just created. Add the tag name in the "Release title" field and the relevant CHANGELOG.md section in the "Describe this release" textarea field. Finally, attach the generated APK release file and click "Publish release".