Skip to content

How to document optional or "available" plugins? #11

@michaelborn

Description

@michaelborn

So EmojiLog support adds two additional plugins:

  • EmojiLogCommitParser
  • EmojiLogCommitAnalyzer

I'd like to add docs for these to the README, but the current ### Plugins: description does not apply to "optional" plugins:

Plugins:

The following plugins are used in CommandBox Semantic Release. They are ran in
the order they are presented...

How can we change the README docs from "these plugins run in X order" to "the following plugins are available:"?

What if we change the table from a list of plugins which implement XYZ interface to a table of interfaces, with supported implementations?

Interface Purpose Default Options
CommitAnalyzer Analyzes the commits to determine the release type. DefaultCommitAnalyzer DefaultCommitAnalyzer, EmojiLogCommitAnalyzer

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions