146 lines
3.7 KiB
Markdown
146 lines
3.7 KiB
Markdown
### 🎭 Comment reactions
|
||
|
||
The *reactions* plugin displays overall reactions on your recent issues and issue comments.
|
||
|
||
<table>
|
||
<td align="center">
|
||
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.reactions.svg">
|
||
<img width="900" height="1" alt="">
|
||
</td>
|
||
</table>
|
||
|
||
#### ➡️ Available options
|
||
|
||
<!--options-->
|
||
<table>
|
||
<tr>
|
||
<td align="center" nowrap="nowrap">Type</i></td><td align="center" nowrap="nowrap">Description</td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><code>plugin_reactions</code></td>
|
||
<td rowspan="2"><p>Display average issue comments reactions</p>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>boolean</code>
|
||
<br>
|
||
<b>default:</b> no<br></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><code>plugin_reactions_limit</code></td>
|
||
<td rowspan="2"><p>Maximum number of issue comments to parse</p>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||
<i>(0 ≤
|
||
𝑥
|
||
≤ 1000)</i>
|
||
<br>
|
||
<b>default:</b> 200<br></td>
|
||
</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>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||
<i>(0 ≤
|
||
𝑥
|
||
≤ 1000)</i>
|
||
<br>
|
||
<b>default:</b> 100<br></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><code>plugin_reactions_limit_discussions</code></td>
|
||
<td rowspan="2"><p>Maximum number of discussions opened to parse</p>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||
<i>(0 ≤
|
||
𝑥
|
||
≤ 1000)</i>
|
||
<br>
|
||
<b>default:</b> 100<br></td>
|
||
</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>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||
<i>(0 ≤
|
||
𝑥
|
||
≤ 1000)</i>
|
||
<br>
|
||
<b>default:</b> 100<br></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><code>plugin_reactions_days</code></td>
|
||
<td rowspan="2"><p>Maximum comments age</p>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>number</code>
|
||
<i>(0 ≤
|
||
𝑥)</i>
|
||
<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>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>string</code>
|
||
<br>
|
||
<b>default:</b> absolute<br>
|
||
<b>allowed values:</b><ul><li>absolute</li><li>relative</li></ul></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><code>plugin_reactions_details</code></td>
|
||
<td rowspan="2"><p>Additional details</p>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><b>type:</b> <code>array</code>
|
||
<i>(comma-separated)</i>
|
||
<br>
|
||
<b>allowed values:</b><ul><li>count</li><li>percentage</li></ul></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap"><code>plugin_reactions_ignored</code></td>
|
||
<td rowspan="2"><p>Users to ignore</p>
|
||
<img width="900" height="1" alt=""></td>
|
||
</tr>
|
||
<tr>
|
||
<td nowrap="nowrap">⏩ Inherits <code>users_ignored</code><br>
|
||
<b>type:</b> <code>array</code>
|
||
<i>(comma-separated)</i>
|
||
<br></td>
|
||
</tr>
|
||
</table>
|
||
<!--/options-->
|
||
|
||
*[→ Full specification](metadata.yml)*
|
||
|
||
#### ℹ️ Examples workflows
|
||
|
||
<!--examples-->
|
||
```yaml
|
||
name: Comment reactions
|
||
uses: lowlighter/metrics@latest
|
||
with:
|
||
filename: metrics.plugin.reactions.svg
|
||
token: ${{ secrets.METRICS_TOKEN }}
|
||
base: ''
|
||
plugin_reactions: 'yes'
|
||
plugin_reactions_limit: 100
|
||
plugin_reactions_details: percentage
|
||
|
||
```
|
||
<!--/examples--> |