Skip to content

[Ops] Script to automatically build a list of plugins, with links to READMEs. #71663

@stacey-gammon

Description

@stacey-gammon

I would like to write a script that generates a plugin-list.asciidoc file. It would loop through everything in src/plugins and x-pack/plugins and build a link to the readme, or if no readme exists, print a warning in the asciidoc.

If the README was in md, it'd be a link to the Markdown in the repo. If the README is in asciidoc, it'd use the header for the link and add an include line.

I'd also like to hook this into ci so if the output of the command doesn't match the contents inside the generated file, an error would be thrown.

The goals are:

  • A central place to link to all of our available plugins and services.
  • A guarantee that this list stays up to date.
  • A way to easily see which plugins/services are missing READMEs. Adds motivation to add READMEs. Eventually we could even block ci on READMEs existing.

Something like this being autogenerated and guaranteed to be up to date:

Screen Shot 2020-07-14 at 10 56 24 AM

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions