Files
metrics/source/plugins/notable/metadata.yml

83 lines
2.4 KiB
YAML

name: "🎩 Notable contributions"
category: github
description: This plugin displays badges of repositories where you commited at least once on default branch.
examples:
+indepth analysis: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.indepth.svg
contributions in organizations only: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.svg
index: 15
supports:
- user
scopes:
- public_access
inputs:
plugin_notable:
description: Enable notable plugin
type: boolean
default: no
plugin_notable_filter:
description: |
Query filter
Based on [GitHub search syntax](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax).
Supported fields are `stars`, `forks` and `watchers`
If `plugin_notable_indepth` is enabled, `commits`, `commits.user`, `commits.user%` and `maintainer` fields are also supported.
Some repositories may not be able to reported advanced stats and in the case the default behaviour will be to bypass filtering
type: string
default: ""
example: stars:>500 forks:>100 maintainer:true commits.user%:>5
plugin_notable_skipped:
description: Skipped repositories
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3, ...
inherits: repositories_skipped
plugin_notable_from:
description: |
Filter by repository owner account type
- `all`: no filtering
- `organization`: only organization accounts repositories
- `user`: only user accounts repositories
type: string
default: organization
values:
- all
- organization
- user
plugin_notable_repositories:
description: |
Toggle repository name display
Note that Repositories hosted by user account will always be fully displayed
type: boolean
default: no
plugin_notable_indepth:
description: Indepth mode
type: boolean
default: no
extras: yes
plugin_notable_types:
description: |
Contribution types filter
Use a combination of below values to include repositories where:
- `commit`: a commit on default branch was made
- `pull_request`: a pull request was opened
- `issue`: an issue was opened
type: array
format: comma-separated
default: commit
example: commit, pull_request
values:
- commit
- pull_request
- issue