2016-10-26 06:48:03 +00:00
|
|
|
# Release Checklist
|
2022-10-24 15:06:40 +00:00
|
|
|
|
|
|
|
|
1. Make sure that `CHANGELOG.md` is up-to-date with all entries in the "Unreleased" section.
|
|
|
|
|
2. Invoke the [release workflow](https://github.com/mitmproxy/mitmproxy/actions/workflows/release.yml) from the GitHub UI.
|
|
|
|
|
3. The spawned workflow runs will require manual confirmation on GitHub which you need to approve twice:
|
|
|
|
|
https://github.com/mitmproxy/mitmproxy/actions
|
2023-11-04 11:29:59 +00:00
|
|
|
4. Once everything has been deployed, update the website.
|
|
|
|
|
5. Verify that the front-page download links for all platforms are working.
|
2017-03-15 21:36:58 +00:00
|
|
|
|
2019-12-21 01:57:53 +00:00
|
|
|
### GitHub Releases
|
2021-03-11 18:13:02 +00:00
|
|
|
|
2022-10-24 15:06:40 +00:00
|
|
|
- CI will automatically create a GitHub release:
|
|
|
|
|
https://github.com/mitmproxy/mitmproxy/releases
|
2017-03-15 21:36:58 +00:00
|
|
|
|
2019-12-21 01:57:53 +00:00
|
|
|
### PyPi
|
2021-03-11 18:13:02 +00:00
|
|
|
|
2022-10-24 15:06:40 +00:00
|
|
|
- CI will automatically push a wheel to GitHub:
|
|
|
|
|
https://pypi.python.org/pypi/mitmproxy
|
2017-03-15 21:36:58 +00:00
|
|
|
|
2019-12-21 01:57:53 +00:00
|
|
|
### Docker
|
2021-03-11 18:13:02 +00:00
|
|
|
|
2022-10-24 15:06:40 +00:00
|
|
|
- CI will automatically push images to Docker Hub:
|
|
|
|
|
https://hub.docker.com/r/mitmproxy/mitmproxy/tags/
|
2018-05-18 08:37:56 +00:00
|
|
|
|
2019-12-21 01:57:53 +00:00
|
|
|
### Docs
|
2021-03-11 18:13:02 +00:00
|
|
|
|
2022-10-24 15:06:40 +00:00
|
|
|
- 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
|
|
|
|
|
|
2023-11-04 11:29:59 +00:00
|
|
|
- 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`
|
2019-12-21 01:57:53 +00:00
|
|
|
|
|
|
|
|
### Website
|
2021-03-11 18:13:02 +00:00
|
|
|
|
|
|
|
|
- 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:
|
2021-03-16 15:17:27 +00:00
|
|
|
https://github.com/mitmproxy/www/blob/main/src/config.toml
|
2021-03-11 18:13:02 +00:00
|
|
|
- Update docs menu here:
|
2021-03-16 15:17:27 +00:00
|
|
|
https://github.com/mitmproxy/www/blob/main/src/themes/mitmproxy/layouts/partials/header.html
|
2021-03-11 18:13:02 +00:00
|
|
|
- Run `./build && ./upload-test`.
|
|
|
|
|
- If everything looks alright at https://www-test.mitmproxy.org, run `./upload-prod`.
|
2018-05-16 23:15:15 +00:00
|
|
|
|
2019-12-21 01:57:53 +00:00
|
|
|
### Prepare for next release
|
2021-03-11 18:13:02 +00:00
|
|
|
|
2021-03-16 15:17:27 +00:00
|
|
|
- Last but not least, bump the major version on main in
|
|
|
|
|
[https://github.com/mitmproxy/mitmproxy/blob/main/mitmproxy/version.py](mitmproxy/version.py) and add a `.dev` suffix.
|
