2016-10-26 06:48:03 +00:00
# Release Checklist
2019-12-21 01:17:39 +00:00
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.
2018-05-16 23:15:15 +00:00
2018-07-31 12:11:37 +00:00
- Update CHANGELOG.
2020-02-21 22:09:31 +00:00
- Verify that the compiled mitmweb assets are up-to-date.
2018-07-31 12:11:37 +00:00
- Verify that all CI tests pass.
2019-12-21 01:17:39 +00:00
- Verify that `mitmproxy/version.py` is correct. Remove `.dev` suffix if it exists.
2021-04-05 08:08:21 +00:00
- Tag the release and push to GitHub.
2021-03-11 18:13:02 +00:00
- `git tag v4.0.0`
- `git push origin v4.0.0`
2018-07-31 12:11:37 +00:00
- Wait for tag CI to complete.
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
2021-04-05 08:08:21 +00:00
- Create release notice on GitHub
2018-05-17 09:25:32 +00:00
[here ](https://github.com/mitmproxy/mitmproxy/releases/new ) 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:
2018-07-31 12:11:37 +00:00
`You can find the latest release packages at https://mitmproxy.org/downloads/.`
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
2018-07-31 12:11:37 +00:00
- The created wheel is uploaded to PyPi automatically.
2019-12-21 01:57:53 +00:00
- Please verify that https://pypi.python.org/pypi/mitmproxy has the latest version.
2018-02-25 16:49:54 +00:00
2019-12-21 01:57:53 +00:00
### Homebrew
2021-03-11 18:13:02 +00:00
2018-05-17 09:25:32 +00:00
- The Homebrew maintainers are typically very fast and detect our new relese
within a day.
2018-05-17 08:47:21 +00:00
- If you feel the need, you can run this from a macOS machine:
2020-04-13 08:16:40 +00:00
`brew bump-formula-pr --url https://github.com/mitmproxy/mitmproxy/archive/v<version number here>.tar.gz 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
2019-12-21 01:33:58 +00:00
- 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.
2020-04-13 08:17:08 +00:00
- Please verify that the latest tag points to the most recent image (same digest / hash).
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
2021-07-16 11:32:17 +00:00
- `./build.py` . If everything looks alright, continue with
2021-03-11 18:13:02 +00:00
- `./upload-stable.sh` ,
2021-07-16 11:32:17 +00:00
- `DOCS_ARCHIVE=true ./build.py` , and
2021-03-11 18:13:02 +00:00
- `./upload-archive.sh v4` . Doing this now already saves you from switching back to an old state on the next release.
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.
