mitmproxy/release/README.md

# 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.
Update and rename README.mkd to README.md 2016-10-26 06:48:03 +00:00			`# Release Checklist`

update release instructions 2017-03-15 21:36:58 +00:00			`Make sure run all these steps on the correct branch you want to create a new release for!`
			- Verify `mitmproxy/version.py`
Update README.md 2017-02-21 17:37:56 +00:00			`- Update CHANGELOG`
update release instructions 2017-03-15 21:36:58 +00:00			`- Verify that all CI tests pass`
			`- Tag the release and push to Github`
Remove support for Python 3.5 There are a number of significant improvements in Python3.6 - especially in asyncio - that makes ditching Python 3.5 compelling. The next Ubuntu LTS will be released before the next version of mitmproxy, and will include Python 3.6 in base. This patch removes support for testing under Python 3.5 and changes our documentation. There are deeper changes in the type system and so forth that we will make over time. 2018-03-31 04:13:24 +00:00			`- For alphas, betas, and release candidates, use lightweight tags.`
only use annotated tags for version calculation 2018-01-07 19:25:27 +00:00			`This is necessary so that the .devXXXX counter does not reset.`
Remove support for Python 3.5 There are a number of significant improvements in Python3.6 - especially in asyncio - that makes ditching Python 3.5 compelling. The next Ubuntu LTS will be released before the next version of mitmproxy, and will include Python 3.6 in base. This patch removes support for testing under Python 3.5 and changes our documentation. There are deeper changes in the type system and so forth that we will make over time. 2018-03-31 04:13:24 +00:00			`- For final releases, use annotated tags.`
only use annotated tags for version calculation 2018-01-07 19:25:27 +00:00			`This makes the .devXXXX counter reset.`
Update and rename README.mkd to README.md 2016-10-26 06:48:03 +00:00			`- Wait for tag CI to complete`
update release instructions 2017-03-15 21:36:58 +00:00
			`## GitHub Release`
Update README.md 2017-04-28 12:24:57 +00:00			`- Create release notice on Github [here](https://github.com/mitmproxy/mitmproxy/releases/new)`
update release instructions 2017-03-15 21:36:58 +00:00			`- Attach all files from the new release folder on https://snapshots.mitmproxy.org`

			`## PyPi`
improve release instructions 2018-02-25 16:49:54 +00:00			- `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.`
update release instructions 2017-03-15 21:36:58 +00:00
			`## Docker`
Update README.md 2016-11-22 22:11:57 +00:00			`- Update docker-releases repo`
update release docs 2017-03-04 10:50:21 +00:00			`- Create a new branch based of master for major versions.`
update release instructions 2017-03-15 21:36:58 +00:00			`- 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:`
Python 3.5 is dead -- long live Python 3.6! fixes #2266 2018-03-31 15:25:21 +00:00			* `virtualenv -ppython3.6 venv && source venv/bin/activate && pip install mitmproxy && pip freeze`
fix markdown 2017-04-30 09:21:28 +00:00			`- 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/)
update release instructions 2018-02-25 16:33:06 +00:00			`- 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`

update release instructions 2018-04-05 16:26:55 +00:00			`## Website`
			`- Update version here: https://github.com/mitmproxy/www/blob/master/src/config.toml`
			- `./build && ./upload-test`
			- If everything looks alright: `./upload-prod`

update release instructions 2018-02-22 13:21:46 +00:00			`## 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.`