search

YahnisElsts / plugin-update-checker

A custom update checker for WordPress plugins. Useful if you don't want to host your project in the official WP repository, but would still like it to support automatic updates. Despite the name, it also works with themes.
MIT License
2.27k stars 411 forks source link

Plugin Description and Changelog #565

Closed hupe13 closed 8 months ago

hupe13 commented 8 months ago

I'm trying to integrate PUC 5.4 into my plugin. Updates are working as expected, but the "Description" and "Changelog" don't seem to work properly.

I use tags. If I want to see details I get as "Description" the "Description" line from plugins php file: * Description: DSGVO Snippet for Extensions for Leaflet Map

The "Changelog" is from changes.md. This is fine.

I tested to publish a Release. But there I got the "Description" as above and the "Changelog" is the description of the release.

I want to see in "Description" the content of readme.md and if I published a release I would like to get the content of changes.md in "Changelog".

The compatibility with WordPress 6.4.3 is unknown, although this is specified.

Am I understanding or doing something wrong? How does it work properly?

Thank you very much.

YahnisElsts commented 8 months ago

Generally speaking, PUC tries to emulate how updates work for plugins hosted on wordpress.org. Everything else is an added-on extra. So the best-supported path is to structure your plugin as if you were going to upload it to the wordpress.org plugin directory.

In this case, that means having a readme.txt file that follows the WordPress plugin readme standard. If a valid readme.txt exists, PUC will parse it and take the description and changelog from there. Using changes.md and release descriptions are fallback strategies.

hupe13 commented 8 months ago

Then that was my mistake. Plugins in the WordPress reposority do not necessarily need a readme.txt, a readme.md will do the job also. Then I will provide a readme.txt for PUC and a readme.md for Github.

Thank you very much.

YahnisElsts commented 8 months ago

Plugins in the WordPress reposority do not necessarily need a readme.txt, a readme.md will do the job also.

Hmm, I wasn't aware of that. Looking at the documentation, I see no mention of readme.md. Is it one of those things where it's not "officially" supported but it works anyway?

hupe13 commented 8 months ago

See here. I don't have a readme.txt in Extensions for Leaflet Map .

YahnisElsts commented 8 months ago

I see, thanks for the information.

hupe13 commented 8 months ago

For the sake of completeness: There is a difference between my WordPress readme.md and the Github readme.md in the FAQ section.