Pillow/RELEASING.md
2018-08-30 19:21:00 +10:00

4.2 KiB

Release Checklist

Main Release

Released quarterly on the first day of January, April, July, October.

  • Open a release ticket e.g. https://github.com/python-pillow/Pillow/issues/3154
  • Develop and prepare release in master branch.
  • Check Travis CI and AppVeyor CI to confirm passing tests in master branch.
  • Check that all of the wheel builds Pillow Wheel Builder pass the tests in Travis CI.
  • In compliance with PEP 440, update version identifier in src/PIL/_version.py
  • Update CHANGES.rst.
  • Run pre-release check via make release-test in a freshly cloned repo.
  • Create branch and tag for release e.g.:
    $ git branch 5.2.x
    $ git tag 5.2.0
    $ git push --all
    $ git push --tags
  • Create source distributions e.g.:
    $ make sdist

Point Release

Released as needed for security, installation or critical bug fixes.

  • Make necessary changes in master branch.
  • Update CHANGES.rst.
  • Cherry pick individual commits from master branch to release branch e.g. 5.2.x.
  • Check Travis CI to confirm passing tests in release branch e.g. 5.2.x.
  • Check out release branch e.g.:
    git checkout -t remotes/origin/5.2.x
  • In compliance with PEP 440, update version identifier in src/PIL/_version.py
  • Run pre-release check via make release-test.
  • Create tag for release e.g.:
    $ git tag 5.2.1
    $ git push --tags
  • Create source distributions e.g.:
    $ make sdist

Embargoed Release

Released as needed privately to individual vendors for critical security-related bug fixes.

  • Prepare patch for all versions that will get a fix. Test against local installations.
  • Commit against master, cherry pick to affected release branches.
  • Run local test matrix on each release & Python version.
  • Privately send to distros.
  • Run pre-release check via make release-test
  • Amend any commits with the CVE #
  • On release date, tag and push to GitHub.
    git checkout 2.5.x
    git tag 2.5.3
    git push origin 2.5.x
    git push origin --tags
  • Create source distributions e.g.:
    $ make sdist

Binary Distributions

Windows

Mac and Linux

    $ git clone https://github.com/python-pillow/pillow-wheels
    $ cd pillow-wheels
    $ git submodule init
    $ git submodule update Pillow
    $ cd Pillow
    $ git fetch --all
    $ git checkout [[release tag]]
    $ cd ..
    $ git commit -m "Pillow -> 5.2.0" Pillow
    $ git push

Publicize Release

Documentation