Skip to content

Commit af69d3a

Browse files
release-process: update based on recent 8.5 releases and discussions (#19939)
1 parent 0b4fbf2 commit af69d3a

File tree

1 file changed

+65
-21
lines changed

1 file changed

+65
-21
lines changed

docs/release-process.md

Lines changed: 65 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ repository available according to the release schedule.
66
The release schedule for each version is published on the
77
[PHP wiki](https://wiki.php.net):
88

9+
- [PHP 8.5](https://wiki.php.net/todo/php85)
910
- [PHP 8.4](https://wiki.php.net/todo/php84)
1011
- [PHP 8.3](https://wiki.php.net/todo/php83)
1112
- [PHP 8.2](https://wiki.php.net/todo/php82)
@@ -137,14 +138,23 @@ slightly different steps. We'll call attention where the steps differ.
137138
> During the first RC release, you will create (and push!) the version
138139
> branch for the pre-GA release, e.g., `PHP-8.2`. See
139140
> "[Forking a new version branch](#forking-a-new-version-branch)" below.
140-
> From this point forward, all pre-GA release branches will be created from
141+
> For the last RC release, and the subsequent GA release, follow the post-GA
142+
> procedure, but until that point, pre-GA release branches will be created from
141143
> this version branch. Again, these release branches are local-only. Do not
142144
> push them!
143145
>
144146
> ```shell
145-
> git checkout -b php-X.Y.0beta2-local-release-branch upstream/PHP-X.Y
147+
> git checkout -b php-X.Y.0RC3-local-release-branch upstream/PHP-X.Y
146148
> ```
147149
150+
> 💬 **Hint** \
151+
> The *patch-level version branch* for GA (PHP X.Y.0) is created as part of the
152+
> last *planned* RC release (currently PHP X.Y.0RC4). After the last RC is released,
153+
> additional bug fixes in the PHP X.Y branch will not be a part of PHP X.Y.0. If a regression
154+
> is found that warrants including a fix in PHP X.Y.0, use the same process as
155+
> for other patch releases - merge the patch as normal to PHP X.Y, and then cherry-pick
156+
> the patch to the patch-level PHP X.Y.0 branch.
157+
148158
> 🔷 **Non-stable version branches: post-GA** \
149159
> After GA, you will create (and push) a new *patch-level version branch*
150160
> along with each non-stable release. For example, if you are building a
@@ -263,7 +273,7 @@ slightly different steps. We'll call attention where the steps differ.
263273
The NEWS is updated at the *start* of the cycle for the next tag, e.g.
264274
[Update NEWS for PHP 8.2.0 alpha2][] was sent as part of tagging 8.2.0 alpha **1**.
265275
266-
🔷 **For post-GA releases only,** switch back to the *version branch* for
276+
🔷 **For post-GA releases, and the final pre-GA RC** switch back to the *version branch* for
267277
your release (e.g., `PHP-8.2`) and bump the version numbers in
268278
`main/php_version.h`, `Zend/zend.h`, `configure.ac` and `NEWS`. This prepares
269279
the version branch for the next version.
@@ -291,11 +301,19 @@ slightly different steps. We'll call attention where the steps differ.
291301
> Only release tags should have version numbers in these files that do not
292302
> end in `-dev` (e.g., `8.1.7`, `8.1.7RC1`, `8.2.0alpha1`, etc.).
293303
294-
10. Push the changes to the `php-src`.
304+
Do not forget to merge up PHP-X.Y all the way to master. When resolving
305+
the conflicts, ignore the changes from PHP-X.Y in higher branches. It
306+
means using something like `git checkout --ours .` when on PHP.X.Y+1 or
307+
master after the merge resulting in the conflicts.
308+
309+
Be sure to set up a merge driver for the NEWS file as described in
310+
the [Git FAQ page on the PHP wiki][gitfaq-mandatory].
311+
312+
11. Push the changes to the `php-src`.
295313
296314
```shell
297315
git push upstream php-X.Y.ZRCn # tag name
298-
git push upstream PHP-X.Y.Z # patch-level version branch (post-GA only)
316+
git push upstream PHP-X.Y.Z # patch-level version branch (beginning with the last RC before GA)
299317
git push upstream PHP-X.Y # version branch (post-branch creation only)
300318
git push upstream master # version branch (pre-branch creation only)
301319
```
@@ -306,28 +324,23 @@ slightly different steps. We'll call attention where the steps differ.
306324
>
307325
> Local-only release branches should not be pushed!
308326
309-
Do not forget to merge up PHP-X.Y all the way to master. When resolving
310-
the conflicts, ignore the changes from PHP-X.Y in higher branches. It
311-
means using something like `git checkout --ours .` when on PHP.X.Y+1 or
312-
master after the merge resulting in the conflicts.
313-
314-
11. Run the following using the release tag to export the tree, create the
327+
12. Run the following using the release tag to export the tree, create the
315328
`configure` script, and build and compress three tarballs (`.tar.gz`,
316329
`.tar.bz2` and `.tar.xz`).
317330
318331
```shell
319332
./scripts/dev/makedist php-X.Y.ZRCn
320333
```
321334
322-
12. Run the following using the release tag and your GPG key ID to sign the
335+
13. Run the following using the release tag and your GPG key ID to sign the
323336
tarballs and save the signatures to `php-X.Y.ZRCn.manifest`, which you can
324337
upload to GitHub and include in the announcement emails.
325338
326339
```shell
327340
./scripts/dev/gen_verify_stub X.Y.ZRCn YOURKEYID > php-X.Y.ZRCn.manifest
328341
```
329342
330-
13. If you have the [GitHub command line tool][] installed, run the following to
343+
14. If you have the [GitHub command line tool][] installed, run the following to
331344
create a public Gist for the manifest file:
332345
333346
```shell
@@ -336,7 +349,7 @@ slightly different steps. We'll call attention where the steps differ.
336349
337350
Or you may go to https://gist.github.com to create it manually.
338351
339-
14. Copy the tarballs (using scp, rsync, etc.) to your `public_html/` folder on
352+
15. Copy the tarballs (using scp, rsync, etc.) to your `public_html/` folder on
340353
downloads.php.net.
341354
342355
```shell
@@ -347,10 +360,10 @@ slightly different steps. We'll call attention where the steps differ.
347360
> If you do not have a `public_html` directory, create it and set its
348361
> permissions to `0755`.
349362
350-
15. Now the tarballs and signatures may be found at
363+
16. Now the tarballs and signatures may be found at
351364
`https://downloads.php.net/~yourname/`, e.g. https://downloads.php.net/~derick/.
352365
353-
16. Once the release is tagged, contact the release-managers@php.net distribution
366+
17. Once the release is tagged, contact the release-managers@php.net distribution
354367
list so that Windows binaries can be created. Once those are made, they may
355368
be found at https://windows.php.net/qa/.
356369
@@ -519,8 +532,8 @@ slightly different steps. We'll call attention where the steps differ.
519532
520533
> 💬 **Hint** \
521534
> You should have created this branch when packaging the non-stable release
522-
> candidate for this version. If it is for a PHP-X.Y.0 version, then just
523-
> create and push this branch.
535+
> candidate for this version. If it is for a PHP-X.Y.0 version, then the branch
536+
> was created as part of the final planned release candidate, PHP-X.Y.0RC4.
524537
525538
2. If a CVE commit needs to be merged to the release, have it committed to
526539
the base branches and [merged upwards as usual][] (e.g. commit the CVE fix
@@ -938,13 +951,20 @@ feature development that cannot go into the new version.
938951
See [Prepare for PHP 8.2][] and [Prepare for PHP 8.2 (bis)][] for an example
939952
of what this commit should include.
940953
941-
4. Push the new version branch and the changes to the `master` branch, with an
954+
> 💬 **Hint** \
955+
> The API version numbers in `Zend/zend_extensions.h`, `Zend/zend_modules.h`, and
956+
> `main/php.h` in `master` need to be **greater** than the ones in the new `PHP-X.Y`
957+
> branch. Generally, use the `YYYYMMDD` date for the *Thursday* as the value for the
958+
> `PHP-X.Y` API numbers, and for the *Friday* as the value for the `master` API
959+
> numbers. This ensures that `master` is always considered newer than the version branch.
960+
961+
5. Push the new version branch and the changes to the `master` branch, with an
942962
appropriate commit message (e.g., "master is now for PHP 8.3.0-dev").
943963
944-
5. Immediately notify internals@ of the new branch and advise on the new merging
964+
6. Immediately notify internals@ of the new branch and advise on the new merging
945965
order. For example: https://news-web.php.net/php.internals/99903
946966
947-
6. Update `web-php:git.php` and https://wiki.php.net/vcs/gitworkflow to reflect
967+
7. Update `web-php:git.php` and https://wiki.php.net/vcs/gitworkflow to reflect
948968
the new branch.
949969
950970
For example:
@@ -959,6 +979,29 @@ feature development that cannot go into the new version.
959979
> minor improvements and bug fixes. All major improvements and new features must
960980
> wait.
961981
982+
8. Most CI configuration is maintained on the lowest supported branch; update the
983+
applicable files there to reflect the branch cut, and then upmerge that commit
984+
5 times to get it to `master`. The following files need to be updated:
985+
986+
* `.github/nightly_matrix.php` (add new branch, update version for `master`)
987+
[Updating after 8.5 branch cut](https://github.com/php/php-src/commit/197921a8aa7b2f9af103b439bf913e23d6ed1b98)
988+
989+
* `.github/scripts/windows/find-target-branch.bat` (update version for `master`)
990+
[Updating after 8.5 branch cut](https://github.com/php/php-src/commit/107075605db6f1b15ce275e345d1c6de04a464b0)
991+
992+
9. Update the `.github/workflows/push.yml` file with the new branch. This file
993+
does not need to be updated on the lowest supported branch; just update the
994+
newly cut branch to add the new branch to the branches that the workflow
995+
runs on (and then upmerge once to `master`). For example:
996+
997+
* [Updating after 8.5 branch cut](https://github.com/php/php-src/commit/77af4780ccbbc96a2f85a3102d45a15f5e26f9c9)
998+
999+
10. Update the version of `php/php-sdk-binary-tools` used for the `master` branch for the `nightly`
1000+
and `push` jobs to account for the new version; this can be done before the branch cut if
1001+
the new version is ready. If the new version is not ready when the branch is cut, file an
1002+
issue reporting the problem. For example:
1003+
1004+
* [Updating after 8.5 branch cut](https://github.com/php/php-src/commit/f7e39a91d5a9de53fc4e184f6fce6116ca3388a1)
9621005
9631006
## Preparing for the initial stable version (PHP X.Y.0)
9641007
@@ -1167,5 +1210,6 @@ volunteers to begin the selection process for the next release managers.
11671210
[GPG key]: https://en.wikipedia.org/wiki/GNU_Privacy_Guard
11681211
[Generating a new GPG key]: https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key
11691212
[sign your GPG key]: https://carouth.com/articles/signing-pgp-keys/
1213+
[gitfaq-mandatory]: https://wiki.php.net/vcs/gitfaq#mandatory_git_settings
11701214
[Send emails from a different address or alias]: https://support.google.com/mail/answer/22370?hl=en
11711215
[security-txt]: https://github.com/php/policies/blob/main/security-policies.rst#making-changes-to-securitytxt

0 commit comments

Comments
 (0)