moodlehq / moodle-plugin-release

Template for GitHub Actions YAML file allowing to automatically release tagged version in the Moodle Plugins directory
GNU General Public License v3.0
13 stars 4 forks source link

Proposal: allow to submit new images and description of the plugin #8

Open jpahullo opened 2 years ago

jpahullo commented 2 years ago

I'm really in love with this repo and the enabling github action to automatically submit new plugin releases on every new incremental tag. Actually, I'm using it on all the plugins I have published under Moodle Plugins. It makes so easy to have them up-to-date. Thanks for this big project.

The thing is: updating the plugins with new releases I saw some image from a really old Moodle version, so they may require some remaking.

And thinking about the plugin github repo as single source of truth: would it be interesting for this tool (or maybe another project) that enables:

  1. Updating the images provided on the Moodle Plugins side with the images of the repo, like pix/plugin/. So that, if the directory is present and some images are there, they replace any existing image from the Moodle Plugins plugin. On the Moodle Plugins side, we could use the image hash to check if they are the same or not.
  2. Update the description of the plugin, with for instance the content of a DESCRIPTION.md.

I think it would have sense doing it under the releasing of new verions, since this is actually the moment where with high probability you update these details of your plugin.

I was tempted to put this debate into the Moodle Dev chat, but prefered to list the details here.

mudrd8mz commented 2 years ago

Thanks @jpahullo for the suggestion.

Similarly to adding support for releases, this will eventually require a new external function provided by the plugins directory allowing to edit the plugin (change description, images etc). Once such a service exists, it can be integrated multiple ways.

https://docs.moodle.org/dev/Plugins_directory_API

I must say I don't think we would have time and resources to work on this anytime soon.