mitmproxy/release/README.md

Release Checklist

Make sure run all these steps on the correct branch you want to create a new release for!

• Verify mitmproxy/version.py
• Update CHANGELOG
• Verify that all CI tests pass
• Tag the release and push to Github
  • For alphas, betas, and release candidates, use lightweight tags.
    This is necessary so that the .devXXXX counter does not reset.
  • For final releases, use annotated tags.
    This makes the .devXXXX counter reset.
• Wait for tag CI to complete

GitHub Release

• Create release notice on Github here
• Attach all files from the new release folder on https://snapshots.mitmproxy.org

PyPi

• Upload wheel to pypi: twine upload <mitmproxy-...-.whl

Docker

• Update docker-releases repo
  • Create a new branch based of master for major versions.
  • Update the dependencies in alpine/requirements.txt
    • Creating a fresh venv, pip-installing the new wheel in there, and then export all packages:
    • virtualenv -ppython3.5 venv && source venv/bin/activate && pip install mitmproxy && pip freeze
  • Tag the commit with the correct version
    • 2.0.0 for new major versions
    • 2.0.2 for new patch versions
• Update latest tag here
• Check that the build for this tag succeeds https://hub.docker.com/r/mitmproxy/mitmproxy/builds/
• If build failed:
  • Fix it and commit
  • git tag 3.0.2 the new commit
  • git push origin :refs/tags/3.0.2 to delete the old remote tag
  • git push --tags to push the new tag
  • Check the build details page again

Homebrew

• The Homebrew maintainers are typically very fast and detect our new relese within a day
• If you want to speed this up:
  • brew bump-formula-pr --url=https://github.com/mitmproxy/mitmproxy/archive/v3.0.2.tar.gz mitmproxy

Prepare for next release

• Last but not least, bump the version on master in https://github.com/mitmproxy/mitmproxy/blob/master/mitmproxy/version.py for major releases.