Skip to content

Commit 51fbc9c

Browse files
authoredApr 10, 2023
Merge pull request #7074 from hugovk/release-refinement
Release refinement
2 parents 38c2449 + cb68187 commit 51fbc9c

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed
 

‎RELEASING.md

+28-18
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,13 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th.
1111
* [ ] Develop and prepare release in `main` branch.
1212
* [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) and [AppVeyor](https://ci.appveyor.com/project/python-pillow/Pillow) to confirm passing tests in `main` branch.
1313
* [ ] Check that all of the wheel builds [Pillow Wheel Builder](https://github.com/python-pillow/pillow-wheels) pass the tests in Travis CI and GitHub Actions.
14-
* [ ] In compliance with [PEP 440](https://www.python.org/dev/peps/pep-0440/), update version identifier in `src/PIL/_version.py`
14+
* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py`
1515
* [ ] Update `CHANGES.rst`.
1616
* [ ] Run pre-release check via `make release-test` in a freshly cloned repo.
1717
* [ ] Create branch and tag for release e.g.:
1818
```bash
1919
git branch 5.2.x
2020
git tag 5.2.0
21-
git push --all
2221
git push --tags
2322
```
2423
* [ ] Create and check source distribution:
@@ -32,8 +31,11 @@ Released quarterly on January 2nd, April 1st, July 1st and October 15th.
3231
python3 -m twine upload dist/Pillow-5.2.0*
3332
```
3433
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases)
35-
* [ ] In compliance with [PEP 440](https://www.python.org/dev/peps/pep-0440/), increment and append `.dev0` to version identifier in `src/PIL/_version.py`
36-
34+
* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/),
35+
increment and append `.dev0` to version identifier in `src/PIL/_version.py` and then:
36+
```bash
37+
git push --all
38+
```
3739
## Point Release
3840

3941
Released as needed for security, installation or critical bug fixes.
@@ -45,16 +47,12 @@ Released as needed for security, installation or critical bug fixes.
4547
git checkout -t remotes/origin/5.2.x
4648
```
4749
* [ ] Cherry pick individual commits from `main` branch to release branch e.g. `5.2.x`, then `git push`.
48-
49-
50-
5150
* [ ] Check [GitHub Actions](https://github.com/python-pillow/Pillow/actions) and [AppVeyor](https://ci.appveyor.com/project/python-pillow/Pillow) to confirm passing tests in release branch e.g. `5.2.x`.
52-
* [ ] In compliance with [PEP 440](https://www.python.org/dev/peps/pep-0440/), update version identifier in `src/PIL/_version.py`
51+
* [ ] In compliance with [PEP 440](https://peps.python.org/pep-0440/), update version identifier in `src/PIL/_version.py`
5352
* [ ] Run pre-release check via `make release-test`.
5453
* [ ] Create tag for release e.g.:
5554
```bash
5655
git tag 5.2.1
57-
git push
5856
git push --tags
5957
```
6058
* [ ] Create and check source distribution:
@@ -67,7 +65,10 @@ Released as needed for security, installation or critical bug fixes.
6765
python3 -m twine check --strict dist/*
6866
python3 -m twine upload dist/Pillow-5.2.1*
6967
```
70-
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases)
68+
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases) and then:
69+
```bash
70+
git push
71+
```
7172

7273
## Embargoed Release
7374

@@ -83,31 +84,40 @@ Released as needed privately to individual vendors for critical security-related
8384
```bash
8485
git checkout 2.5.x
8586
git tag 2.5.3
86-
git push origin 2.5.x
8787
git push origin --tags
8888
```
8989
* [ ] Create and check source distribution:
9090
```bash
9191
make sdist
9292
```
9393
* [ ] Create [binary distributions](https://github.com/python-pillow/Pillow/blob/main/RELEASING.md#binary-distributions)
94-
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases)
94+
* [ ] Publish the [release on GitHub](https://github.com/python-pillow/Pillow/releases) and then:
95+
```bash
96+
git push origin 2.5.x
97+
```
9598

9699
## Binary Distributions
97100

98-
### Windows
99-
* [ ] Download the artifacts from the [GitHub Actions "Test Windows" workflow](https://github.com/python-pillow/Pillow/actions/workflows/test-windows.yml)
100-
and copy into `dist/`
101-
102-
### Mac and Linux
101+
### macOS and Linux
103102
* [ ] Use the [Pillow Wheel Builder](https://github.com/python-pillow/pillow-wheels):
104103
```bash
105104
git clone https://github.com/python-pillow/pillow-wheels
106105
cd pillow-wheels
107106
./update-pillow-tag.sh [[release tag]]
108107
```
109108
* [ ] Download wheels from the [Pillow Wheel Builder release](https://github.com/python-pillow/pillow-wheels/releases)
110-
and copy into `dist/`
109+
and copy into `dist/`. For example using [GitHub CLI](https://github.com/cli/cli) from the main repo:
110+
```bash
111+
gh release download --dir dist --pattern "*.whl" --repo python-pillow/pillow-wheels
112+
```
113+
114+
### Windows
115+
* [ ] Download the artifacts from the [GitHub Actions "Test Windows" workflow](https://github.com/python-pillow/Pillow/actions/workflows/test-windows.yml)
116+
and copy into `dist/`. For example using [GitHub CLI](https://github.com/cli/cli):
117+
```bash
118+
gh run download --dir dist
119+
# select dist-x.y.z
120+
```
111121

112122
## Publicize Release
113123

0 commit comments

Comments
 (0)