Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
michaelborn opened this issue Nov 19, 2021 · 0 comments
Open

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

michaelborn opened this issue Nov 19, 2021 · 0 comments

Comments

@michaelborn
Copy link
Contributor

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant