Support » How-To and Troubleshooting » plugin readme file problem

plugin readme file problem

  • Hi,

    I’ve created a new plugin (http://wordpress.org/extend/plugins/blogtext/), and created a readme file – however, it doesn’t seem to be being picked up and none of the fields and descriptions I’ve written (including the all important installation section) are there! Also all tabs show the same content (except for the stats tab).

    I’ve validated my readme file and it says that it was ok (except for some missing headers that I don’t use), am I missing something?

    Any help would be greatly appreciated!


Viewing 8 replies - 1 through 8 (of 8 total)
  • Give it a while (a few hours, up to a day or two). Sometimes it’s just a Plugin Repository server-cache issue.

    Your readme.txt in trunk looks fine, as does the readme.txt file in \tags.9.0c

    Ok. I was just confused because it already took the tag (0.9.0c), the title (which was “blogtext” before I uploaded the readme file), and the sections (had only “Description” before I uploaded the readme file).

    Make sure you update \trunk\readme.txt last.

    The way the parser works, it starts reading \trunk\readme.txt. Once it gets to the “Stable Tag” header tag, it reads the value, and then continues parsing from the tag specified.

    So, when you update your Plugin to, e.g. 1.0:

    1) Create \tags\1.0\
    2) Add Plugin files to \tags\1.0
    3) Update \trunk\readme.txt to indicate “Stable Tag: 1.0”

    Then things should work a bit more smoothly.

    Sounds quite counter-intuitive. Also this breaks how Subversion works (where you first update the trunk and then create a tag). If this is true, it seems that this is a bug.

    No, you use trunk for development, keeping your actual Plugin files updated in trunk, then tag when stable, then update trunk\readme.txt to point to the current stable version.

    And then the readme in the “release tag” hasn’t the correct version in it. Doesn’t sound right to me.

    Just commit readme.txt separately, if that makes it easier for you.

    In the end, though, what matters is that, when the parser hits “Stable Tag” in \trunk\readme.txt, files actually exist in the specified tag directory.

    Yap, that worked. However, still this is something new users should be told about (for example in the FAQ: http://wordpress.org/extend/plugins/about/faq/ ).

Viewing 8 replies - 1 through 8 (of 8 total)
  • The topic ‘plugin readme file problem’ is closed to new replies.