History

Maximilian Hils ec9bc455c0 remove ci credential check it turns out pull requests from trusted contributors do have access to secrets, so we can't do that check. Checking for the repo only doesn't make much sense.		2021-01-05 22:00:54 +01:00
..
docker	post-release updates	2020-11-01 16:12:49 +01:00
hooks	remove upstreamed pyinstaller hooks	2020-11-02 02:39:56 +01:00
installbuilder	Windows: build pyinstaller onedir and use it for installer	2021-01-05 15:56:33 +01:00
specs	Windows: build pyinstaller onedir and use it for installer	2021-01-05 15:56:33 +01:00
windows-store-experiment	minor fixes for windows package	2017-06-14 14:35:51 +02:00
.gitignore	pin snapshot server hostkey, update pysftp	2018-01-04 14:12:30 +01:00
README.md	update release instructions	2020-12-19 23:29:44 +01:00
__init__.py	cibuild: Consolidate build environment and add tests	2018-05-24 11:06:43 +12:00
cibuild.py	remove ci credential check	2021-01-05 22:00:54 +01:00

README.md

Release Checklist

These steps assume you are on the correct branch and have a git remote called origin that points to the mitmproxy/mitmproxy repo. If necessary, create a major version branch starting off the release tag (e.g. git checkout -b v4.x v4.0.0) first.

Update CHANGELOG.
Verify that the compiled mitmweb assets are up-to-date.
Verify that all CI tests pass.
Verify that mitmproxy/version.py is correct. Remove .dev suffix if it exists.
Tag the release and push to Github.
- git tag v4.0.0
- git push origin v4.0.0
Wait for tag CI to complete.

GitHub Releases

Create release notice on Github here if not already auto-created by the tag.
We DO NOT upload release artifacts to GitHub anymore. Simply add the following snippet to the notice: You can find the latest release packages at https://mitmproxy.org/downloads/.

PyPi

The created wheel is uploaded to PyPi automatically.
Please verify that https://pypi.python.org/pypi/mitmproxy has the latest version.

Homebrew

The Homebrew maintainers are typically very fast and detect our new relese within a day.
If you feel the need, you can run this from a macOS machine: brew bump-formula-pr --url https://github.com/mitmproxy/mitmproxy/archive/v<version number here>.tar.gz mitmproxy

Docker

The docker image is built by our CI workers and pushed to Docker Hub automatically.
Please verify that https://hub.docker.com/r/mitmproxy/mitmproxy/tags/ has the latest version.
Please verify that the latest tag points to the most recent image (same digest / hash).

Docs

./build.sh. If everything looks alright, continue with
./upload-stable.sh,
DOCS_ARCHIVE=true ./build.sh, and
./upload-archive.sh v4. Doing this now already saves you from switching back to an old state on the next release.

Website

The website does not need to be updated for patch releases. New versions are automatically picked up once they are on the download server.
Update version here: https://github.com/mitmproxy/www/blob/master/src/config.toml
Update docs menu here: https://github.com/mitmproxy/www/blob/master/src/themes/mitmproxy/layouts/partials/header.html
Run ./build && ./upload-test.
If everything looks alright at https://www-test.mitmproxy.org, run ./upload-prod.

Prepare for next release

Last but not least, bump the major version on master in https://github.com/mitmproxy/mitmproxy/blob/master/mitmproxy/version.py and add a .dev suffix.