From 4c2227758ec7bda10213220dc022e0e105533391 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 07:09:53 -0400 Subject: [PATCH 01/11] Add template for quarterly release issue --- .github/ISSUE_TEMPLATE/RELEASE.md | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/RELEASE.md diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md new file mode 100644 index 000000000..db4c94a09 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -0,0 +1,45 @@ +--- +name: Release +about: Schedule a release +--- + +## Main Release + +Released quarterly on January 2nd, April 1st, July 1st and October 15th. + +* [ ] Open a release ticket e.g. https://github.com/python-pillow/Pillow/issues/3154 +* [ ] Develop and prepare release in `main` branch. + * [ ] Add release notes for 11.2.1 https://github.com/python-pillow/Pillow/pull/8885 +* [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) to confirm passing tests in `main` branch. +* [ ] Check that all the wheel builds pass the tests in the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml) jobs by manually triggering them. +* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py` +* [ ] Run pre-release check via `make release-test` in a freshly cloned repo. +* [ ] Create branch and tag for release e.g.: + ```bash + git branch [[MAJOR.MINOR.PATCH]] + git tag [[MAJOR.MINOR.PATCH]] + git push --tags + ``` +* [ ] Check the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml) has passed, including the "Upload release to PyPI" job. This will have been triggered by the new tag. +* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases). +* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), increment and append `.dev0` to version identifier in `src/PIL/_version.py` and then: + ```bash + git push --all + ``` + +## Publicize Release + +* [ ] Announce release availability via [Mastodon](https://fosstodon.org/@pillow) e.g. https://fosstodon.org/@pillow/110639450470725321 + +## Documentation + +* [ ] Make sure the [default version for Read the Docs](https://pillow.readthedocs.io/en/stable/) is up-to-date with the release changes + +## Docker Images + +* [ ] Update Pillow in the Docker Images repository + ```bash + git clone https://github.com/python-pillow/docker-images + cd docker-images + ./update-pillow-tag.sh [[release tag]] + ``` From 8ab3bc469ec4ebcc7e5bc5a848fd59bd4a9a8221 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 08:21:48 -0400 Subject: [PATCH 02/11] Update .github/ISSUE_TEMPLATE/RELEASE.md Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index db4c94a09..c5bae8b2a 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -9,7 +9,7 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th. * [ ] Open a release ticket e.g. https://github.com/python-pillow/Pillow/issues/3154 * [ ] Develop and prepare release in `main` branch. - * [ ] Add release notes for 11.2.1 https://github.com/python-pillow/Pillow/pull/8885 + * [ ] Add release notes e.g. https://github.com/python-pillow/Pillow/pull/8885 * [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) to confirm passing tests in `main` branch. * [ ] Check that all the wheel builds pass the tests in the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml) jobs by manually triggering them. * [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py` From 0205fb4fa2e9905dcec12715d60b5f4a75e30266 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 08:21:57 -0400 Subject: [PATCH 03/11] Update .github/ISSUE_TEMPLATE/RELEASE.md Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/RELEASE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index c5bae8b2a..72499e01d 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -16,8 +16,8 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th. * [ ] Run pre-release check via `make release-test` in a freshly cloned repo. * [ ] Create branch and tag for release e.g.: ```bash - git branch [[MAJOR.MINOR.PATCH]] - git tag [[MAJOR.MINOR.PATCH]] + git branch [[MAJOR.MINOR]].0 + git tag [[MAJOR.MINOR]].0 git push --tags ``` * [ ] Check the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml) has passed, including the "Upload release to PyPI" job. This will have been triggered by the new tag. From 6f672191ad83b522c47e1facdeb12889f91a5824 Mon Sep 17 00:00:00 2001 From: Andrew Murray <3112309+radarhere@users.noreply.github.com> Date: Sun, 27 Apr 2025 22:30:35 +1000 Subject: [PATCH 04/11] Branch uses .x --- .github/ISSUE_TEMPLATE/RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index 72499e01d..5dd070886 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -16,7 +16,7 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th. * [ ] Run pre-release check via `make release-test` in a freshly cloned repo. * [ ] Create branch and tag for release e.g.: ```bash - git branch [[MAJOR.MINOR]].0 + git branch [[MAJOR.MINOR]].x git tag [[MAJOR.MINOR]].0 git push --tags ``` From 6881863eab8106a6a0e3cb788f11c7d0d71cf124 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 15:37:42 -0400 Subject: [PATCH 05/11] Update .github/ISSUE_TEMPLATE/RELEASE.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/RELEASE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index 5dd070886..97701f30e 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -1,6 +1,7 @@ --- -name: Release -about: Schedule a release +name: "Maintainers only: Release" +about: For maintainers to schedule a quarterly release +labels: Release --- ## Main Release From fcaffa22293c41851e9e28b3229b981398deacda Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 15:37:50 -0400 Subject: [PATCH 06/11] Update .github/ISSUE_TEMPLATE/RELEASE.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index 97701f30e..d7b246378 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -4,7 +4,7 @@ about: For maintainers to schedule a quarterly release labels: Release --- -## Main Release +## Main release Released quarterly on January 2nd, April 1st, July 1st and October 15th. From 1eba198b62d1444e72f598db805121022a19ab04 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 15:37:56 -0400 Subject: [PATCH 07/11] Update .github/ISSUE_TEMPLATE/RELEASE.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index d7b246378..16bf30fdc 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -28,7 +28,7 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th. git push --all ``` -## Publicize Release +## Publicize release * [ ] Announce release availability via [Mastodon](https://fosstodon.org/@pillow) e.g. https://fosstodon.org/@pillow/110639450470725321 From e6ff42303b54d16e213b2152984a39f07742fcaf Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 15:38:02 -0400 Subject: [PATCH 08/11] Update .github/ISSUE_TEMPLATE/RELEASE.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/RELEASE.md b/.github/ISSUE_TEMPLATE/RELEASE.md index 16bf30fdc..20d1ac79b 100644 --- a/.github/ISSUE_TEMPLATE/RELEASE.md +++ b/.github/ISSUE_TEMPLATE/RELEASE.md @@ -36,7 +36,7 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th. * [ ] Make sure the [default version for Read the Docs](https://pillow.readthedocs.io/en/stable/) is up-to-date with the release changes -## Docker Images +## Docker images * [ ] Update Pillow in the Docker Images repository ```bash From e140027262b95d26080b5d58e095d2e294609e69 Mon Sep 17 00:00:00 2001 From: "Jeffrey A. Clark" Date: Sun, 27 Apr 2025 15:45:40 -0400 Subject: [PATCH 09/11] Move checklist to issue template --- RELEASING.md | 23 ++--------------------- 1 file changed, 2 insertions(+), 21 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 932beb2c2..b626d7d23 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -7,27 +7,8 @@ information about how the version numbers line up with releases. Released quarterly on January 2nd, April 1st, July 1st and October 15th. -* [ ] Open a release ticket e.g. https://github.com/python-pillow/Pillow/issues/3154 -* [ ] Develop and prepare release in `main` branch. -* [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) to confirm passing tests in `main` branch. -* [ ] Check that all the wheel builds pass the tests in the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml) jobs by manually triggering them. -* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py` -* [ ] Run pre-release check via `make release-test` in a freshly cloned repo. -* [ ] Create branch and tag for release e.g.: - ```bash - git branch 5.2.x - git tag 5.2.0 - git push --tags - ``` -* [ ] Check the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml) - has passed, including the "Upload release to PyPI" job. This will have been triggered - by the new tag. -* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases). -* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), - increment and append `.dev0` to version identifier in `src/PIL/_version.py` and then: - ```bash - git push --all - ``` +* [ ] Create a new issue and select the "Release" template. + ## Point Release Released as needed for security, installation or critical bug fixes. From f1d5cdaa07fbf4377d3cf4c68377e64998619b60 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Mon, 28 Apr 2025 06:17:47 +1000 Subject: [PATCH 10/11] Use sentence case --- README.md | 4 ++-- RELEASING.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1cae558ad..365d356a0 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ This library provides extensive file format support, an efficient internal repre The core image library is designed for fast access to data stored in a few basic pixel formats. It should provide a solid foundation for a general image processing tool. -## More Information +## More information - [Documentation](https://pillow.readthedocs.io/) - [Installation](https://pillow.readthedocs.io/en/latest/installation/basic-installation.html) @@ -107,6 +107,6 @@ The core image library is designed for fast access to data stored in a few basic - [Changelog](https://github.com/python-pillow/Pillow/releases) - [Pre-fork](https://github.com/python-pillow/Pillow/blob/main/CHANGES.rst#pre-fork) -## Report a Vulnerability +## Report a vulnerability To report a security vulnerability, please follow the procedure described in the [Tidelift security policy](https://tidelift.com/docs/security). diff --git a/RELEASING.md b/RELEASING.md index b626d7d23..c160e96f5 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,15 +1,15 @@ -# Release Checklist +# Release checklist See https://pillow.readthedocs.io/en/stable/releasenotes/versioning.html for information about how the version numbers line up with releases. -## Main Release +## Main release Released quarterly on January 2nd, April 1st, July 1st and October 15th. * [ ] Create a new issue and select the "Release" template. -## Point Release +## Point release Released as needed for security, installation or critical bug fixes. @@ -39,7 +39,7 @@ Released as needed for security, installation or critical bug fixes. git push ``` -## Embargoed Release +## Embargoed release Released as needed privately to individual vendors for critical security-related bug fixes. @@ -63,7 +63,7 @@ Released as needed privately to individual vendors for critical security-related git push origin 2.5.x ``` -## Publicize Release +## Publicize release * [ ] Announce release availability via [Mastodon](https://fosstodon.org/@pillow) e.g. https://fosstodon.org/@pillow/110639450470725321 @@ -71,7 +71,7 @@ Released as needed privately to individual vendors for critical security-related * [ ] Make sure the [default version for Read the Docs](https://pillow.readthedocs.io/en/stable/) is up-to-date with the release changes -## Docker Images +## Docker images * [ ] Update Pillow in the Docker Images repository ```bash From dbe538a1307dc14c3ecb685819f28f22c02060ab Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Mon, 28 Apr 2025 06:19:18 +1000 Subject: [PATCH 11/11] Updated template name --- RELEASING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASING.md b/RELEASING.md index c160e96f5..3c6188c82 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -7,7 +7,7 @@ information about how the version numbers line up with releases. Released quarterly on January 2nd, April 1st, July 1st and October 15th. -* [ ] Create a new issue and select the "Release" template. +* [ ] Create a new issue and select the "Maintainers only: Release" template. ## Point release