coreruleset
Move the plugin registry list to a different format
While having the list in the readme is easy to read, it is not easy to consume from other sites (website, documentation, etc.).
We should think on a way to manage the list using yaml for example, and generating the README.md file using a custom github action.
Requirements
- [ ] have a readme skeleton where the table will be placed
- [ ] create github action for post-processing yaml plugin list
- [ ] process the yaml content and insert the table into the markdown file
- [ ] commit the file in the GHA
Do we want this?
Having it as human-readable text makes it easy to edit and update. Almost no presumed knowledge or skills are required, which is a good thing.
If the plugin registry contained info like version numbers, releases etc. then I would agree having it machine-readable would be a benefit. But we don't store that sort of information here. Unless that is part of the plan?
We need to consume the registry data in other places. I don't think parsing html would do no good.
But we always could just forget about this, and in the future someone will take care of keeping things up to date across repos 🤷 .
We're currently doing a markdown table. I guess converting that automatically to a yaml format would be doable, but a bit brittle.
So writing the yaml and then generating the markdown would be better still human readable from my perspective. As long as it's not xml, we should be find.
@RedXanadu Is yaml really such a no-go? If yes, I can do the shell one-liner to do markdown -> yaml.
