History

Maximilian Hils 3828373e91 macOS: Use correct entitlements for binary distribution (#6480 ) Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>		2023-11-13 13:52:55 +01:00
..
docker	fix #6267 (#6270 )	2023-07-20 10:45:43 +00:00
installbuilder	build macOS app bundle (#6447 )	2023-11-03 11:21:55 +00:00
specs	macOS: Use correct entitlements for binary distribution (#6480 )	2023-11-13 13:52:55 +01:00
windows-installer	revise display names	2022-07-25 14:38:21 +02:00
.gitignore	pin snapshot server hostkey, update pysftp	2018-01-04 14:12:30 +01:00
README.md	Update release/README.md	2023-11-04 12:29:59 +01:00
build-and-deploy-docker.py	[autofix.ci] apply automated fixes	2023-02-27 08:37:11 +01:00
build.py	build macOS app bundle (#6447 )	2023-11-03 11:21:55 +00:00
deploy-microsoft-store.py	simplify ci build script, add MSIX installer and Microsoft store.	2022-07-25 01:22:57 +02:00
deploy.py	release ci: upload binaries to r2	2023-07-02 22:19:58 +02:00
github-release-notes.txt	add more release automation (#5674 )	2022-10-24 17:06:40 +02:00
release.py	ensure that we trigger the tag workflow	2023-08-04 11:23:44 +02:00
selftest.py	build macOS app bundle (#6447 )	2023-11-03 11:21:55 +00:00

README.md

Release Checklist

Make sure that CHANGELOG.md is up-to-date with all entries in the "Unreleased" section.
Invoke the release workflow from the GitHub UI.
The spawned workflow runs will require manual confirmation on GitHub which you need to approve twice: https://github.com/mitmproxy/mitmproxy/actions
Once everything has been deployed, update the website.
Verify that the front-page download links for all platforms are working.

GitHub Releases

CI will automatically create a GitHub release:
https://github.com/mitmproxy/mitmproxy/releases

PyPi

CI will automatically push a wheel to GitHub:
https://pypi.python.org/pypi/mitmproxy

Docker

CI will automatically push images to Docker Hub:
https://hub.docker.com/r/mitmproxy/mitmproxy/tags/

Docs

CI will automatically update the stable docs and create an archive version:
https://docs.mitmproxy.org/archive/vMAJOR/

Download Server

CI will automatically push binaries to our download S3 bucket:
https://mitmproxy.org/downloads/

Microsoft Store

CI will automatically update the Microsoft Store version:
https://apps.microsoft.com/store/detail/mitmproxy/9NWNDLQMNZD7
There is a review process, binaries may take a day to show up.

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-cask-pr mitmproxy

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/main/src/config.toml
Update docs menu here: https://github.com/mitmproxy/www/blob/main/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 main in https://github.com/mitmproxy/mitmproxy/blob/main/mitmproxy/version.py and add a .dev suffix.