Files
metrics/source/plugins/contributors/metadata.yml
2022-01-15 22:36:41 -05:00

72 lines
1.9 KiB
YAML

name: "🏅 Repository contributors"
category: github
description: This plugin display repositories contributors from a commit range along with additional stats.
examples:
+by contribution types: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.contributors.categories.svg
by number of contributions: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.contributors.contributions.svg
index: 6
supports:
- repository
scopes:
- public_access
inputs:
plugin_contributors:
description: Enable contributors plugin
type: boolean
default: no
plugin_contributors_base:
description: Base reference (commit, tag, branch, etc.)
type: string
default: ""
example: commit, tag or branch
plugin_contributors_head:
description: Head reference (commit, tag, branch, etc.)
type: string
default: master
plugin_contributors_ignored:
description: |
Ignored users
Useful to ignore bots activity
type: array
format: comma-separated
default: ""
inherits: users_ignored
plugin_contributors_contributions:
description: Toggle number of contributions display
type: boolean
default: no
plugin_contributors_sections:
description: |
Displayed sections
- `contributors`: all contributors
- `categories`: contributors sorted by contributions categories
type: array
format: comma-separated
default: contributors
example: contributors
values:
- contributors
- categories
plugin_contributors_categories:
description: |
Configure contribution categories
This option required `plugin_contributors_sections` to have `categories` in it to be effective
Pass a JSON object mapping category with fileglobs
type: json
default: |
{
"📚 Documentation": ["README.md", "docs/**"],
"💻 Code": ["source/**", "src/**"],
"#️⃣ Others": ["*"]
}
extras: yes