diff options
| author | Thomas Kriechbaumer <Kriechi@users.noreply.github.com> | 2018-05-17 10:47:21 +0200 |
|---|---|---|
| committer | Thomas Kriechbaumer <thomas@kriechbaumer.name> | 2018-05-17 18:28:43 +0200 |
| commit | 762aa287cc45579ae504bb15f1975959cb8b215e (patch) | |
| tree | 7145c429e5617752358232011cfedcc25025b8f0 /release | |
| parent | 052b378ea67b0fb15496d6e208efd9711e9802bd (diff) | |
| download | mitmproxy-762aa287cc45579ae504bb15f1975959cb8b215e.tar.gz mitmproxy-762aa287cc45579ae504bb15f1975959cb8b215e.tar.bz2 mitmproxy-762aa287cc45579ae504bb15f1975959cb8b215e.zip | |
Update README.md
Diffstat (limited to 'release')
| -rw-r--r-- | release/README.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/release/README.md b/release/README.md index c70082d7..d15f88a0 100644 --- a/release/README.md +++ b/release/README.md @@ -4,8 +4,9 @@ Make sure run all these steps on the correct branch you want to create a new release for! The command examples assume that you have a git remote called `upstream` that points to the `mitmproxy/mitmproxy` repo. -- Verify `mitmproxy/version.py` +- Verify that `mitmproxy/version.py` is correct - Update CHANGELOG +- Update CONTRIBUTORS - Verify that all CI tests pass - Create a major version branch - e.g. `v4.x`. Assuming you have a remote repo called `upstream` that points to the mitmproxy/mitmproxy repo:: - `git checkout -b v4.x upstream/master` @@ -19,19 +20,18 @@ release for! The command examples assume that you have a git remote called - Wait for tag CI to complete ## GitHub Release -- Create release notice on Github [here](https://github.com/mitmproxy/mitmproxy/releases/new) -- Grab a copy of the current snapshot files from snapshots.mitmproxy.org: - - `aws s3 cp --recursive s3://snapshots.mitmproxy.org/vXXX/ .` -- Attach all files to the release +- Create release notice on Github [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: + `You can find the latest release packages on our snapshot server: https://snapshots.mitmproxy.org/v<version number here>` ## PyPi - Upload the whl file you downloaded in the prevous step - `twine upload ./tmp/snap/mitmproxy-4.0.0-py3-none-any.whl` ## Homebrew -- **FIXME** This process does not work with 2FA. -- `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. +- 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-formula-pr --url https://github.com/mitmproxy/mitmproxy/archive/v<version number here>` ## Docker - Update docker-releases repo |