mitmproxy/release
Maximilian Hils 518fb94124
Harden CI Pipeline (#4590)
* ci: use actions/checkout@v2

* ci: always specify python version

* ci: pin external actions

* ci: split docs job, pin immediate dependencies

* ci: correct hugo sha256sum

* ci: full repo fetch depth for tests

* ci: use pip-tools to pin all the things

* ci: minor fixes

* ci: fixup

* ci: streamline pinned install

* ci: minor fixes

* ci: fix py3.8 pins

* ci: don't persist checkout credentials

* ci: always run local linter

* ci: test docs deployment from actions-hardening branch

* ci: fix docs job

* ci: pass in credentials

* ci: fix file permissions

* ci: try harder to fix docs deploy

* ci: fix docker artifact name

* Revert "ci: test docs deployment from actions-hardening branch"

This reverts commit 30cfb7a814b61a8926fc0623e3e70b6dd5106d90.

* unpin PyPI dependencies

* ci: install tox first

* ci: fixups

* ci: fixups

* ci: fixups

* ci: fixups
2021-05-11 11:17:09 +02:00
..
docker Harden CI Pipeline (#4590) 2021-05-11 11:17:09 +02:00
hooks remove upstreamed pyinstaller hooks 2020-11-02 02:39:56 +01:00
installbuilder Windows: build pyinstaller onedir and use it for installer 2021-01-05 15:56:33 +01:00
specs Windows: build pyinstaller onedir and use it for installer 2021-01-05 15:56:33 +01:00
windows-store-experiment Improve Markdown syntax(styling) (#4496) 2021-03-11 19:13:02 +01:00
__init__.py cibuild: Consolidate build environment and add tests 2018-05-24 11:06:43 +12:00
.gitignore pin snapshot server hostkey, update pysftp 2018-01-04 14:12:30 +01:00
cibuild.py Harden CI Pipeline (#4590) 2021-05-11 11:17:09 +02:00
deploy.py Harden CI Pipeline (#4590) 2021-05-11 11:17:09 +02:00
README.md Fix typo: Github should be GitHub (#4541) 2021-04-05 10:08:21 +02:00

Release Checklist

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.

  • Update CHANGELOG.
  • Verify that the compiled mitmweb assets are up-to-date.
  • Verify that all CI tests pass.
  • Verify that mitmproxy/version.py is correct. Remove .dev suffix if it exists.
  • Tag the release and push to GitHub.
    • git tag v4.0.0
    • git push origin v4.0.0
  • Wait for tag CI to complete.

GitHub Releases

  • Create release notice on GitHub here 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 at https://mitmproxy.org/downloads/.

PyPi

Homebrew

  • 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>.tar.gz mitmproxy

Docker

  • 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.
  • Please verify that the latest tag points to the most recent image (same digest / hash).

Docs

  • ./build.sh. If everything looks alright, continue with
  • ./upload-stable.sh,
  • DOCS_ARCHIVE=true ./build.sh, and
  • ./upload-archive.sh v4. Doing this now already saves you from switching back to an old state on the next release.

Website

Prepare for next release