Pillow/RELEASING.md

Release Checklist

Main Release

Released quarterly.

• Develop and prepare release in master branch.
• Check Travis CI to confirm passing tests in master branch.
• Update version in:

    PIL/__init__.py setup.py _imaging.c

• Update CHANGES.rst.
• Run pre-release check via make pre.
• Create branch and tag for release e.g.:

    $ git branch 2.9.x
    $ git tag 2.9.0
    $ git push --all
    $ git push --tags

• Create and upload source distributions e.g.:

    $ make sdistup

• Create and upload binary distributions (see below).

Point Release

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

• Make necessary changes in master.
• Cherry pick individual commits.
• Update version in:

    PIL/__init__.py setup.py _imaging.c

• Update CHANGES.rst.
• Run pre-release check via make pre
• Push to release branch in personal repo. Let Travis run cleanly.
• Tag and push to release branch in python-pillow repo.
• Upload source and binary distributions.

Embargoed Release

Security fixes that need to be pushed to the distros prior to public release.

• 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 pre
• 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

• Upload source and binary distributions.

Upload Process

• Contact @cgohlke for Windows binaries.
• From a clean source directory with no extra temp files:

python setup.py sdist --format=zip upload

Or

make sdistup

(Debian requests a tarball, everyone else would just prefer that we choose one and stick to it. So both it is)

• Push a commit to https://github.com/python-pillow/pillow-wheels to build OSX versions (UNDONE latest tag or specific release???)
• Retrieve the OS X Wheels from Rackspace files, upload to PyPi (Twine?)
• Grab Windows binaries, twine upload dist/*.[whl|egg]. Manually upload .exe installers.
• Announce release availability. Twitter, web.

Footnotes¹ have a label² and the footnote's content.

---

1. This is a footnote content. ↩︎

2. A footnote on the label: "@#$%". ↩︎