Release Pillow 8.2.0 on April 1, 2021

[radarhere]

Some things to check before release:

• Add support for reading TIFFs with PlanarConfiguration=2  #5364 (comment): fuzz crash
• Use LZW encoding when saving GIF images #5291: release notes
• Update config for FriBiDi dynamic linking pillow-wheels#181 is needed for the Raqm/FriBiDi changes
• Fuzzers are good
• https://github.com/python-pillow/pillow-security/pull/9 in the pillow-security repo. Release notes should be basically the commit messages

Main Release

Released quarterly on January 2nd, April 1st, July 1st and October 15th.

• Open a release ticket e.g. Release Pillow 5.2.0 on July 1, 2018 #3154
• Develop and prepare release in master branch.
• Check GitHub Actions and AppVeyor to confirm passing tests in master branch.
• Check that all of the wheel builds Pillow Wheel Builder pass the tests in Travis CI and GitHub Actions.
• 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 and check source distribution:

  make sdist
  twine check dist/*

• Create binary distributions
• Check and upload all binaries and source distributions e.g.:

  twine check dist/*
  twine upload dist/Pillow-5.2.0*

• Publish the release on GitHub
• In compliance with PEP 440, increment and append .dev0 to version identifier in src/PIL/_version.py

Binary Distributions

Windows

• Contact @cgohlke for Windows binaries via release ticket e.g. Release 2.9.0 on July 1, 2015 #1174.
• Download and extract tarball from @cgohlke and copy into dist/

Mac and Linux

• Use the Pillow Wheel Builder:

  git clone https://github.com/python-pillow/pillow-wheels
  cd pillow-wheels
  ./update-pillow-tag.sh [[release tag]]

• Download wheels from the Pillow Wheel Builder release
  and copy into dist/

Publicize Release

• Announce release availability via Twitter e.g. https://twitter.com/PythonPillow/status/1013789184354603010

Documentation

• Make sure the default version for Read the Docs is up-to-date with the release changes

Docker Images

• Update Pillow in the Docker Images repository

  git clone https://github.com/python-pillow/docker-images
  cd docker-images
  ./update-pillow-tag.sh [[release tag]]

[hugovk]

Release day tomorrow!

If there are any PRs you'd especially like including, please mention them and we can review and hopefully include them. Thanks!

[nulano]

• Update config for FriBiDi dynamic linking pillow-wheels#181 is needed for the Raqm/FriBiDi changes

[wiredfool]

I'm running the fuzzers overnight to see if anything else is caught quickly. If they come up with anything, I'll try to get it fixed in the morning. I'd rather hold up a release rather than do another one in a few days.

[wiredfool]

python-pillow/pillow-wheels#181 has been merged

[hugovk]

I'm running the fuzzers overnight to see if anything else is caught quickly. If they come up with anything, I'll try to get it fixed in the morning. I'd rather hold up a release rather than do another one in a few days.

Sure, will hold off until you give the all clear. Should we also hold off merging PRs with C changes until after the fuzzing/release?

[wiredfool]

Fuzzers are good.

I'm not averse to C changes, but perhaps not in any of the modules that have pending security issues. (e.g., the quantize thing). OTOH, I don't think any of them are critical, and having a merge party after a release is preferable to one just before a release.

[hugovk]

@cgohlke Please could we have Windows binaries for 8.2.0? Thank you!

[cgohlke]

Here you go.

FWIW, I had to rebuild libtiff with USE_WIN32_FILEIO=ON and disable feature.raqm (otherwise setup.py would link to the DLL found on my system).

[nulano]

disable feature.raqm (otherwise setup.py would link to the DLL found on my system).

The idea is to build wheels with --global-option --vendor-raqm --global-option --vendor-fribidi which should link with HarfBuzz only: python-pillow/pillow-wheels#181 (comment)

[nulano]

I had to rebuild libtiff with USE_WIN32_FILEIO=ON

Discussed in #5243 / #5359

[hugovk]

I restarted the pillow-wheels build after the timeout.

Now, because the wheel builder on the main repo doesn't have access to macos-11.0 runners, the main step is failing so it doesn't upload the wheels.

https://github.com/python-pillow/pillow-wheels/actions/runs/709421322

I'm going to untag 8.2.0 on that repo, then comment out the macos-11.0 job, then retag and push again.

[nulano]

Now, because the wheel builder on the main repo doesn't have access to macos-11.0 runners, the main step is failing so it doesn't upload the wheels.

You can download a zip of all wheels directly from the summary page at the bottom, if it is ok not to make a release on the wheel repo.

[hugovk]

Ah yes, that can be plan C :) Which may be needed as the last job isn't expanding:

[nulano]

Which may be needed as the last job isn't expanding

That is the disabled "latest" job (disabled for tagged builds).

[hugovk]

Ah yes, I see it in this layout:

https://github.com/python-pillow/pillow-wheels/actions/runs/709701865

[hugovk]

And released!

• https://pypi.org/project/Pillow/8.2.0/
• https://twitter.com/PythonPillow/status/1377730469597474817

Thanks @cgohlke and everyone else!

@radarhere Please could you do the macOS 11 wheel in your repo?

[radarhere]

Ok, uploaded to PyPI now, along with the Travis jobs (although the Travis jobs weren't detecting raqm/harfbuzz/fribidi for some reason).

[nulano]

(although the Travis jobs weren't detecting raqm/harfbuzz/fribidi for some reason).

Oops, I don't think anyone actually tested the PR on Travis. Disabling the check on Travis should be fine as the build is done with the --enable-raqm setup flag which ensures Raqm support was built, even if the tests fail to find FriBiDi after installation.