Making WordPress.org

Opened 2 months ago

Closed 3 weeks ago

Last modified 3 weeks ago

#7533 closed feature request (worksforme)

feature request: API for Readme Validation

Reported by: bjorsch's profile bjorsch Owned by:
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

https://wordpress.org/plugins/developers/readme-validator/ is a useful tool. But when you have multiple people contributing to your plugin, it would be nice for validation of changes to the readme to be done by automated CI instead of having to have people visit that webpage.

An API endpoint for validating a readme seems like the best option to achieve that. A wp-cli command or other standalone tool could also work, but since the validation needs to check taxonomies and users on wordpress.org anyway an API would seem to be more straightforward.

Thanks!

Change History (2)

#1 @dd32
3 weeks ago

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

I believe https://wordpress.org/plugins/plugin-check/ is probably the answer here, although it's not 100% up to date with the WordPress.org plugin readme parser all the time.

There's also https://github.com/WordPress/plugin-check-action which runs it on GitHub repositories.

since the validation needs to check taxonomies and users on wordpress.org anyway

I don't think this is really a blocker, there's API's available on WordPress.org that can be used to validate a user exists, and the taxonomy checks are minimal.

#2 @bjorsch
3 weeks ago

I'm disappointed to see that you think this should be closed since the plugin check plugin works for you. We've looked at that plugin check plugin but decided that since almost all of its functionality seems to duplicate checks that we already have implemented in a better-integrated manner in our CI pipeline, we're not very interested in trying to use it.

Note: See TracTickets for help on using tickets.