Skip to content

Commit c2f1b98

Browse files
authored
Add template for quarterly release issue (#8932)
2 parents 6a63907 + dbe538a commit c2f1b98

File tree

3 files changed

+56
-29
lines changed

3 files changed

+56
-29
lines changed

.github/ISSUE_TEMPLATE/RELEASE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: "Maintainers only: Release"
3+
about: For maintainers to schedule a quarterly release
4+
labels: Release
5+
---
6+
7+
## Main release
8+
9+
Released quarterly on January 2nd, April 1st, July 1st and October 15th.
10+
11+
* [ ] Open a release ticket e.g. https://github.com/python-pillow/Pillow/issues/3154
12+
* [ ] Develop and prepare release in `main` branch.
13+
* [ ] Add release notes e.g. https://github.com/python-pillow/Pillow/pull/8885
14+
* [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) to confirm passing tests in `main` branch.
15+
* [ ] 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.
16+
* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py`
17+
* [ ] Run pre-release check via `make release-test` in a freshly cloned repo.
18+
* [ ] Create branch and tag for release e.g.:
19+
```bash
20+
git branch [[MAJOR.MINOR]].x
21+
git tag [[MAJOR.MINOR]].0
22+
git push --tags
23+
```
24+
* [ ] 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.
25+
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases).
26+
* [ ] 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:
27+
```bash
28+
git push --all
29+
```
30+
31+
## Publicize release
32+
33+
* [ ] Announce release availability via [Mastodon](https://fosstodon.org/@pillow) e.g. https://fosstodon.org/@pillow/110639450470725321
34+
35+
## Documentation
36+
37+
* [ ] Make sure the [default version for Read the Docs](https://pillow.readthedocs.io/en/stable/) is up-to-date with the release changes
38+
39+
## Docker images
40+
41+
* [ ] Update Pillow in the Docker Images repository
42+
```bash
43+
git clone https://github.com/python-pillow/docker-images
44+
cd docker-images
45+
./update-pillow-tag.sh [[release tag]]
46+
```

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ This library provides extensive file format support, an efficient internal repre
9595

9696
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.
9797

98-
## More Information
98+
## More information
9999

100100
- [Documentation](https://pillow.readthedocs.io/)
101101
- [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
107107
- [Changelog](https://github.com/python-pillow/Pillow/releases)
108108
- [Pre-fork](https://github.com/python-pillow/Pillow/blob/main/CHANGES.rst#pre-fork)
109109

110-
## Report a Vulnerability
110+
## Report a vulnerability
111111

112112
To report a security vulnerability, please follow the procedure described in the [Tidelift security policy](https://tidelift.com/docs/security).

RELEASING.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,15 @@
1-
# Release Checklist
1+
# Release checklist
22

33
See https://pillow.readthedocs.io/en/stable/releasenotes/versioning.html for
44
information about how the version numbers line up with releases.
55

6-
## Main Release
6+
## Main release
77

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

10-
* [ ] Open a release ticket e.g. https://github.com/python-pillow/Pillow/issues/3154
11-
* [ ] Develop and prepare release in `main` branch.
12-
* [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) to confirm passing tests in `main` branch.
13-
* [ ] 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.
14-
* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py`
15-
* [ ] Run pre-release check via `make release-test` in a freshly cloned repo.
16-
* [ ] Create branch and tag for release e.g.:
17-
```bash
18-
git branch 5.2.x
19-
git tag 5.2.0
20-
git push --tags
21-
```
22-
* [ ] Check the [GitHub Actions "Wheels" workflow](https://github.com/python-pillow/Pillow/actions/workflows/wheels.yml)
23-
has passed, including the "Upload release to PyPI" job. This will have been triggered
24-
by the new tag.
25-
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases).
26-
* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/),
27-
increment and append `.dev0` to version identifier in `src/PIL/_version.py` and then:
28-
```bash
29-
git push --all
30-
```
31-
## Point Release
10+
* [ ] Create a new issue and select the "Maintainers only: Release" template.
11+
12+
## Point release
3213

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

@@ -58,7 +39,7 @@ Released as needed for security, installation or critical bug fixes.
5839
git push
5940
```
6041

61-
## Embargoed Release
42+
## Embargoed release
6243

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

@@ -82,15 +63,15 @@ Released as needed privately to individual vendors for critical security-related
8263
git push origin 2.5.x
8364
```
8465

85-
## Publicize Release
66+
## Publicize release
8667

8768
* [ ] Announce release availability via [Mastodon](https://fosstodon.org/@pillow) e.g. https://fosstodon.org/@pillow/110639450470725321
8869

8970
## Documentation
9071

9172
* [ ] Make sure the [default version for Read the Docs](https://pillow.readthedocs.io/en/stable/) is up-to-date with the release changes
9273

93-
## Docker Images
74+
## Docker images
9475

9576
* [ ] Update Pillow in the Docker Images repository
9677
```bash

0 commit comments

Comments
 (0)