mirror of
https://github.com/Grasscutters/mitmproxy.git
synced 2024-12-12 15:17:45 +00:00
51 lines
2.3 KiB
Markdown
51 lines
2.3 KiB
Markdown
# 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](https://github.com/mitmproxy/mitmproxy/releases/new)
|
|
- Attach all files from the new release folder on https://snapshots.mitmproxy.org
|
|
|
|
## PyPi
|
|
- `tox -e rtool -- upload-release`
|
|
|
|
## Homebrew
|
|
- `tox -e rtool -- homebrew-pr`
|
|
- The Homebrew maintainers are typically very fast and detect our new relese within a day, but we can be a nice citizen and create the PR ourself.
|
|
|
|
## Docker
|
|
- Update docker-releases repo
|
|
- Create a new branch based of master for major versions.
|
|
- Update the dependencies in [alpine/requirements.txt](https://github.com/mitmproxy/docker-releases/commit/3d6a9989fde068ad0aea257823ac3d7986ff1613#diff-9b7e0eea8ae74688b1ac13ea080549ba)
|
|
* Creating a fresh venv, pip-installing the new wheel in there, and then export all packages:
|
|
* `virtualenv -ppython3.6 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](https://hub.docker.com/r/mitmproxy/mitmproxy/~/settings/automated-builds/)
|
|
- Check that the build for this tag succeeds [https://hub.docker.com/r/mitmproxy/mitmproxy/builds/](here)
|
|
- 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
|
|
|
|
## Website
|
|
- Update version here: https://github.com/mitmproxy/www/blob/master/src/config.toml
|
|
- `./build && ./upload-test`
|
|
- If everything looks alright: `./upload-prod`
|
|
|
|
## Prepare for next release
|
|
|
|
- Last but not least, bump the version on master in [https://github.com/mitmproxy/mitmproxy/blob/master/mitmproxy/version.py](mitmproxy/version.py) for major releases.
|