Skip to content

Commit 0ee0482

Browse files
authored
Merge pull request #2765 from WordPress/feature/release-checklist-tweaks
Release checklist: minor updates
2 parents 469c18c + 958418c commit 0ee0482

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

.github/release-checklist.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ PR for tracking changes for the x.x.x release. Target release date: **DOW MONTH
1616
- [ ] PHPCSExtra: check if there have been [releases][phpcsextra-releases] since the last WordPressCS release and check through the changelog to see if there is anything WordPressCS could take advantage of - PR #xxx
1717
- [ ] Check if the minimum WP version property needs updating in `MinimumWPVersionTrait::$default_minimum_wp_version` and if so, action it - PR #xxx
1818
- [ ] Check if the `minimum_wp_version` and `testVersion` properties in `phpcs.xml.dist.sample` need updating and if so, action it - PR #xxx
19+
- [ ] Check if the PHPCompatibility `testVersion` mentioned in the README needs updating and if so, action it - PR #xxx
20+
:pencil2: Rule of thumb: stay in line with the "support three versions of WP below the current version" guideline, as also applied for the `minimum_wp_version`.
1921
- [ ] Check if any of the list based sniffs need updating and if so, action it.
2022
:pencil2: Make sure the "last updated" annotation in the docblocks for these lists has also been updated!
2123
List based sniffs:
@@ -48,14 +50,16 @@ PR for tracking changes for the x.x.x release. Target release date: **DOW MONTH
4850
- [ ] Merge this PR.
4951
- [ ] Make sure all CI builds are green.
5052
- [ ] Tag and create a release against `main` (careful, GH defaults to `develop`!) & copy & paste the changelog to it.
53+
_From within the GH interface: Code tab -> Releases -> "Draft a new release" button at the top of the page._
5154
:pencil2: Check if anything from the link collection at the bottom of the changelog needs to be copied in!
5255
- Remove square brackets from all ticket links or make them proper full links (as GH markdown parser doesn't parse these correctly).
5356
- Change all contributor links to full inline links (as GH markdown parser on the Releases page doesn't parse these correctly).
5457
- [ ] Make sure all CI builds are green.
5558
- [ ] Close the milestone.
5659
- [ ] Open a new milestone for the next release.
5760
- [ ] If any open PRs/issues which were milestoned for this release did not make it into the release, update their milestone.
58-
- [ ] Fast-forward `develop` to be equal to `main`.
61+
- [ ] Fast-forward `develop` to be equal to `main` (`git checkout develop && git pull upstream/develop && git merge main`).
62+
:pencil: Branch protection may need to get a temporary exception to allow for pushing the `develop` branch. Please remember to remove the exception once the push has gone through!
5963

6064
### After release
6165

@@ -69,7 +73,8 @@ PR for tracking changes for the x.x.x release. Target release date: **DOW MONTH
6973
:pencil2: No need to post in the #core-coding-standard channel as that gets an automated release notification anyway.
7074
- [ ] Optionally post in #plugin-review if a sniff was added in a release which was requested by the plugin review team.
7175
- [ ] Optionally post in #core-docs if significant updates were made to the documentation ruleset.
72-
- [ ] Create a Marketing team ["amplify request"][amplify-request].
76+
- [ ] Create a Marketing team ["amplify request"][amplify-request].
77+
Example post: https://github.com/WordPress/marketing/issues/746
7378
- [ ] Submit for the ["Monthly Dev Roundup"][dev-roundup].
7479

7580
[phpcs-releases]: https://github.com/PHPCSStandards/PHP_CodeSniffer/releases

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Install either as a separate ruleset and run it separately against your code or
163163
</rule>
164164
```
165165

166-
Whichever way you run it, do make sure you set the `testVersion` to run the sniffs against. The `testVersion` determines for which PHP versions you will receive compatibility information. The recommended setting for this at this moment is `7.2-` to support the same PHP versions as WordPress Core supports.
166+
Whichever way you run it, do make sure you set the `testVersion` to run the sniffs against. The `testVersion` determines for which PHP versions you will receive compatibility information. The recommended setting for this at this moment is `7.2-` to support the last three WordPress releases.
167167

168168
For more information about setting the `testVersion`, see:
169169
* [PHPCompatibility: Sniffing your code for compatibility with specific PHP version(s)](https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions)

0 commit comments

Comments
 (0)