Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2025-02-01 15:55:28 +00:00
Code Issues Projects Releases Wiki Activity

update release instructions

Browse Source
This commit is contained in:
Maximilian Hils 2019-12-21 02:57:53 +01:00
parent 89c3675741
commit e48c91b0a4
2 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/build-archive
View File

@ -1,5 +1,4 @@
#!/bin/sh #!/bin/sh
set -e set -e
cd src DOCS_ARCHIVE=true ./build-current
DOCS_ARCHIVE=true hugo

29
release/README.md
View File

@ -10,7 +10,7 @@ These steps assume you are on the correct branch and have a git remote called `o
- `git push origin v4.0.0` - `git push origin v4.0.0`
- Wait for tag CI to complete. - Wait for tag CI to complete.
## GitHub Release ### GitHub Releases
- Create release notice on Github - Create release notice on Github
[here](https://github.com/mitmproxy/mitmproxy/releases/new) if not already [here](https://github.com/mitmproxy/mitmproxy/releases/new) if not already
auto-created by the tag. auto-created by the tag.
@ -18,33 +18,36 @@ These steps assume you are on the correct branch and have a git remote called `o
following snippet to the notice: following snippet to the notice:
`You can find the latest release packages at https://mitmproxy.org/downloads/.` `You can find the latest release packages at https://mitmproxy.org/downloads/.`
## PyPi ### PyPi
- The created wheel is uploaded to PyPi automatically. - The created wheel is uploaded to PyPi automatically.
- Please check https://pypi.python.org/pypi/mitmproxy about the latest version. - Please verify that https://pypi.python.org/pypi/mitmproxy has the latest version.
## Homebrew ### Homebrew
- The Homebrew maintainers are typically very fast and detect our new relese - The Homebrew maintainers are typically very fast and detect our new relese
within a day. within a day.
- If you feel the need, you can run this from a macOS machine: - If you feel the need, you can run this from a macOS machine:
`brew bump-formula-pr --url https://github.com/mitmproxy/mitmproxy/archive/v<version number here>` `brew bump-formula-pr --url https://github.com/mitmproxy/mitmproxy/archive/v<version number here>`
## Docker ### Docker
- The docker image is built on Travis and pushed to Docker Hub automatically. - The docker image is built on Travis and pushed to Docker Hub automatically.
- Please check https://hub.docker.com/r/mitmproxy/mitmproxy/tags/ about the latest version. - Please check https://hub.docker.com/r/mitmproxy/mitmproxy/tags/ about the latest version.
- Update `latest` tag: `export VERSION=4.0.3 && docker pull mitmproxy/mitmproxy:$VERSION && docker tag mitmproxy/mitmproxy:$VERSION mitmproxy/mitmproxy:latest && docker push mitmproxy/mitmproxy:latest`. - Update `latest` tag: `export VERSION=4.0.3 && docker pull mitmproxy/mitmproxy:$VERSION && docker tag mitmproxy/mitmproxy:$VERSION mitmproxy/mitmproxy:latest && docker push mitmproxy/mitmproxy:latest`.
## Website ### Docs
- `./build-current`. If everything looks alright, continue with
- `./upload-stable`,
- `./build-archive`, and
- `./upload-archive v4`. Doing this now already saves you from switching back to an old state on the next release.
### Website
- Update version here: - Update version here:
https://github.com/mitmproxy/www/blob/master/src/config.toml https://github.com/mitmproxy/www/blob/master/src/config.toml
- Update docs menu here:
https://github.com/mitmproxy/www/blob/master/src/themes/mitmproxy/layouts/partials/header.html
- Run `./build && ./upload-test`. - Run `./build && ./upload-test`.
- If everything looks alright at http://www-test.mitmproxy.org, run `./upload-prod`. - If everything looks alright at https://www-test.mitmproxy.org, run `./upload-prod`.
## Docs
- Make sure you've uploaded the previous version's docs to archive
- If everything looks alright:
- `./build-current`
- `./upload-stable`
## Prepare for next release ### Prepare for next release
- Last but not least, bump the major version on master in - Last but not least, bump the major version on master in
[https://github.com/mitmproxy/mitmproxy/blob/master/mitmproxy/version.py](mitmproxy/version.py) and add a `.dev` suffix. [https://github.com/mitmproxy/mitmproxy/blob/master/mitmproxy/version.py](mitmproxy/version.py) and add a `.dev` suffix.