WordPress.org

Making WordPress.org

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#1142 closed defect (worksforme)

Updated readme.txt won't reflect on the site

Reported by: hcabrera Owned by:
Milestone: Priority: high
Component: Plugin Directory Keywords: ui-feedback
Cc:

Description

Pushed a new update of one of my plugins around an hour ago, and while the forum already reflects the new version (3.2.3, at the time of writing this) at least both the Changelog tab and the FAQ tab are still reflecting the contents of the previous version of the plugin (and this is even after clearing cache).

Did I miss something?

http://oi60.tinypic.com/2gum4wi.jpg

Change History (7)

#1 @hcabrera
4 years ago

  • Keywords reporter-feedback removed

#2 @swissspidy
4 years ago

It can take some time for the readme changes to be reflected. The index isn't built in real time.

Also, if you use tagged versions, then it reads the readme.txt in the tagged folder. Make sure that one has been updated correctly in svn.

#3 @hcabrera
4 years ago

Yes, I tag my releases. Just reviewed both readme.txt (the one in the trunk and the one in the tagged folder) and both are the same.

I do realize that it takes a bit of time for the index to get updated. Just thought it was odd that the new version is already available for download but that the info wasn't updated. Additionally, a couple of days ago I pushed a minor correction to the FAQ section (both in trunk and tagged version folders) and the forum didn't reflect this change either, which is also why I decided to open this ticket.

Anyways, I'll wait for a bit and see how it goes. If it gets updated, I'll close this ticket.

#4 @hcabrera
4 years ago

  • Resolution set to worksforme
  • Status changed from new to closed

#5 @Otto42
4 years ago

The number of versions you have is quite a lot. 46 of them, to be exact.
http://plugins.svn.wordpress.org/wordpress-popular-posts/tags/

The build process builds each of those as a ZIP, and this can start to add up when you have a lot of old ones. If the process takes too long, it can time out and skip building the updates to the page.

Consider removing some of those old versions if they're not useful or needed anymore. They'll always be in the SVN history, so leaving them around for the release process isn't really necessary.

Also, your readme.txt is up to 31k. It really should be no bigger than 10k. Consider removing some of the old changelog information off into a separate changelog.txt file. Changelogs in the readme.txt don't need to include details descriptions of every change, but should be more of an overview for users of the plugin, so they know what has changed. Detailed changelogs for devs can be put into separate files.

The combination of both of these will reduce the time it takes to update the page and increase the success of the update.

#6 @hcabrera
4 years ago

Thanks for the information, @Otto42. However, I'm not sure how should I go about removing the old versions from the repo? Should I just remove some tagged folders from /tags/?

About limiting the size of the readme.txt file, I'll trim it. Maybe this should be documented somewhere as well? (eg. https://wordpress.org/plugins/about/).

#7 @dd32
4 years ago

However, I'm not sure how should I go about removing the old versions from the repo? Should I just remove some tagged folders from /tags/?

Yes, just removing those tags will do what you want.

However, I'm not sure how should I go about removing the old versions from the repo? Should I just remove some tagged folders from /tags/?

There's also an issue where readme's that are > ~50kb start to become truncated.
If it's not already, those best-practices should be documented in the plugin handbook - https://developer.wordpress.org/plugins/wordpress-org/

Note: See TracTickets for help on using tickets.