Plugin Directory: Improve update-scan author email content and enable Plugin Check update mode#610
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
There was a problem hiding this comment.
Pull request overview
This PR updates the plugin update-scan flow in the Plugin Directory to (1) run Plugin Check in update mode for updated plugins and (2) improve the wording/content of the notification email sent to plugin committers. It also adds a CLI utility to preview (and optionally send) the scan notification email locally.
Changes:
- Pass
--mode=<new|update>to the Plugin Check WP-CLI invocation so scans can run inupdatemode. - Expand/improve the update-scan email body content (intro, no-reply note, Plugin Check guidance/link, closing line).
- Add
bin/preview-plugin-scan-email.phpto preview the email output (and optionally send it).
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
wordpress.org/public_html/wp-content/plugins/plugin-directory/jobs/class-plugin-updates-pcp.php |
Enables Plugin Check --mode flag and refines committer email messaging for update scans. |
wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/preview-plugin-scan-email.php |
Adds a CLI preview tool for the scan email (preview-by-default, optional live send). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dd32
left a comment
There was a problem hiding this comment.
Claude had some re-wording suggestions, that I've included as suggestions here.
The primary one is moving the do-not-reply to the end, as being defensive up front can get off on the wrong foot with some people.
It's probably worthwhile calling PCP a plugin rather than a tool, to point out they install the plugin on a site, not run a stand alone "tool".
As for the bin script, I would probably create a scan-plugin.php and just run the scan, rather than a demo preview. I understand that this was to get the PR up, but a CLI scan command would be helpful.. although I guess plugin-check also has a scan cli command...
…jobs/class-plugin-updates-pcp.php Co-authored-by: Dion Hulse <dd32@dd32.id.au>
…jobs/class-plugin-updates-pcp.php Co-authored-by: Dion Hulse <dd32@dd32.id.au>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| echo "The latest update to your plugin was automatically scanned and some potential issues were flagged for your review.\n\n"; | ||
| echo "To review these issues in detail, install and run the Plugin Check plugin on your own development site:\n"; | ||
| echo "https://wordpress.org/plugins/plugin-check/\n\n"; | ||
|
|
There was a problem hiding this comment.
The PR description mentions adding a non-reply notice and an updated closing line in the author email, but the current notify_plugin_authors() body only adds the new intro + Plugin Check link and retains a single closing line without a non-reply notice. Either update the PR description to match the implemented email copy, or add the missing non-reply/closing text so the behavior matches what’s documented in the PR.
Summary
This PR updates the plugin update-scan notification flow to improve author communication and ensure Plugin Check runs in the correct mode for updated plugins.
Changes included
Enable Plugin Check
updatemode in the scanner commandPlugin_Updates_PCP::run_plugin_check(), the CLI call now passes:--mode=<new|update>jobs/class-plugin-updates-pcp.phpImprove the email body sent to plugin committers after update scans
https://wordpress.org/plugins/plugin-check/jobs/class-plugin-updates-pcp.phpAdd local preview utility for scanner emails
bin/preview-plugin-scan-email.php--sendmode for manual testing.Why
--mode=update.Files changed
wordpress.org/public_html/wp-content/plugins/plugin-directory/jobs/class-plugin-updates-pcp.phpwordpress.org/public_html/wp-content/plugins/plugin-directory/bin/preview-plugin-scan-email.phpVerification
php -l jobs/class-plugin-updates-pcp.phpphp -l bin/preview-plugin-scan-email.php