sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

doc(plugins/reactions): update

Browse Source
This commit is contained in:
lowlighter
2022-01-15 21:20:18 -05:00
parent ac2618d157
commit 84605488d6
2 changed files with 31 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
source/plugins/reactions/README.md
View File

@@ -18,7 +18,7 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions</code></td>
<td rowspan="2"><p>Display average issue comments reactions</p>
<td rowspan="2"><p>Enable reactions plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -28,7 +28,7 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit</code></td>
<td rowspan="2"><p>Maximum number of issue comments to parse</p>
<td rowspan="2"><p>Display limit (issues and pull requests comments)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -41,7 +41,7 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_issues</code></td>
<td rowspan="2"><p>Maximum number of issues and pull requests opened to parse</p>
<td rowspan="2"><p>Display limit (issues and pull requests, first comment)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -54,7 +54,7 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions</code></td>
<td rowspan="2"><p>Maximum number of discussions opened to parse</p>
<td rowspan="2"><p>Display limit (discussions, first comment)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -67,7 +67,7 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions_comments</code></td>
<td rowspan="2"><p>Maximum number of discussions comments opened to parse</p>
<td rowspan="2"><p>Display limit (discussions comments)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -80,7 +80,7 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_days</code></td>
<td rowspan="2"><p>Maximum comments age</p>
<td rowspan="2"><p>Comments maximum age</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -88,11 +88,16 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
<i>(0 ≤
𝑥)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 0<br></td>
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_display</code></td>
<td rowspan="2"><p>Display mode</p>
<ul>
<li><code>absolute</code>: scale percentages using total reactions count</li>
<li><code>relative</code>: scale percentages using highest reaction count</li>
</ul>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -114,7 +119,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_reactions_ignored</code></td>
<td rowspan="2"><p>Users to ignore</p>
<td rowspan="2"><p>Ignored users</p>
<p>Useful to ignore bots activity</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>

40
source/plugins/reactions/metadata.yml
View File

@@ -1,5 +1,8 @@
name: "🎭 Comment reactions"
category: github
description: This plugin displays overall reactions on your recent issues, comments and discussions.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.reactions.svg
index: 8
supports:
- user
@@ -7,66 +10,57 @@ scopes:
- public_access
inputs:
# Enable or disable plugin
plugin_reactions:
description: Display average issue comments reactions
description: Enable reactions plugin
type: boolean
default: no
# Maximum number of issue comments to parse
plugin_reactions_limit:
description: Maximum number of issue comments to parse
description: Display limit (issues and pull requests comments)
type: number
default: 200
min: 0
max: 1000
# Maximum number of issues and pull requests opened to parse
plugin_reactions_limit_issues:
description: Maximum number of issues and pull requests opened to parse
description: Display limit (issues and pull requests, first comment)
type: number
default: 100
min: 0
max: 1000
# Maximum number of discussions opened to parse
plugin_reactions_limit_discussions:
description: Maximum number of discussions opened to parse
description: Display limit (discussions, first comment)
type: number
default: 100
min: 0
max: 1000
# Maximum number of discussions comments opened to parse
plugin_reactions_limit_discussions_comments:
description: Maximum number of discussions comments opened to parse
description: Display limit (discussions comments)
type: number
default: 100
min: 0
max: 1000
# Filter reactions by issue comments age
# Set to 0 to disable age filtering
plugin_reactions_days:
description: Maximum comments age
description: Comments maximum age
type: number
default: 0
min: 0
zero: disable
# Reaction display mode.
# Use this option to fill gauges using:
# - "absolute" to use total reactions count
# - "relative" to use highest reaction count
plugin_reactions_display:
description: Display mode
description: |
Display mode
- `absolute`: scale percentages using total reactions count
- `relative`: scale percentages using highest reaction count
type: string
default: absolute
values:
- absolute
- relative
# Additional details
# If multiple values are specified, emphasis will be set on first value
plugin_reactions_details:
description: Additional details
type: array
@@ -77,9 +71,11 @@ inputs:
- count
- percentage
# Ignored users (useful to ignore bots users)
plugin_reactions_ignored:
description: Users to ignore
description: |
Ignored users
Useful to ignore bots activity
type: array
format: comma-separated
default: ""