[wp-trac] [WordPress Trac] #53049: Add changelog release notes to auto update email notifications

WordPress Trac noreply at wordpress.org
Thu Sep 9 20:58:25 UTC 2021


#53049: Add changelog release notes to auto update email notifications
-----------------------------+-----------------------------
 Reporter:  JosVelasco       |       Owner:  josvelasco
     Type:  enhancement      |      Status:  assigned
 Priority:  normal           |   Milestone:  Future Release
Component:  Upgrade/Install  |     Version:
 Severity:  minor            |  Resolution:
 Keywords:  needs-patch      |     Focuses:  administration
-----------------------------+-----------------------------

Comment (by ChrisHardie):

 I like keeping things simple! :)

 Here's the current recommendation from the [Plugin handbook
 https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-
 works/#file-size]: "As for your changelog, we recommend keeping the
 current release in the readme and splitting the rest out out into it’s own
 file — changelog.txt for example. By storing all the older changelog data
 there, you keep your readme small and allow the people who get really into
 long changelogs to read things on their own."

 So if we hope and assume that plugin developers (for items hosted on wporg
 and not alike) are keeping up readme.txt with the most recent changelog
 entries and changelog.txt with the rest, would it make sense to link
 directly back to those files on the site itself, within the update
 notification email?

 `https://example.com/wp-content/plugins/akismet/changelog.txt`
 `https://example.com/wp-content/plugins/akismet/readme.txt`

 Or are web hosts likely to be blocking web access to random text files
 inside plugin directories?

 Parsing out the actual contents of the changelog content into the email
 message body seems like it would be fraught with formatting and sanitizing
 issues, but I agree it would be nice to see a snippet of it there.

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/53049#comment:29>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list