README

<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>🎭 Comment reactions</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays overall user reactions on recent issues, comments and discussions.</p> </td></tr> <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://github.com">GitHub</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr> <th rowspan="3">Supported features _{<a href="metadata.yml">→ Full specification</a>}</th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td> </tr> <tr> <td><code>👤 Users</code></td> </tr> <tr> <td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>read:packages (optional)</code> <code>repo (optional)</code></td> </tr> <tr> <td colspan="2" align="center"> </img> </tr> </table> <!--/header-->

➡️ Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions</code></h4></td> <td rowspan="2"><p>Enable reactions plugin</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_limit</code></h4></td> <td rowspan="2"><p>Display limit (issues and pull requests comments)</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥 ≤ 1000)</i>

<b>default:</b> 200

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_limit_issues</code></h4></td> <td rowspan="2"><p>Display limit (issues and pull requests, first comment)</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥 ≤ 1000)</i>

<b>default:</b> 100

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_limit_discussions</code></h4></td> <td rowspan="2"><p>Display limit (discussions, first comment)</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥 ≤ 1000)</i>

<b>default:</b> 100

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_limit_discussions_comments</code></h4></td> <td rowspan="2"><p>Display limit (discussions comments)</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥 ≤ 1000)</i>

<b>default:</b> 100

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_days</code></h4></td> <td rowspan="2"><p>Comments maximum age</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>zero behaviour:</b> disable</br> <b>default:</b> 0

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_display</code></h4></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> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>default:</b> absolute

<b>allowed values:</b><ul><li>absolute</li><li>relative</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_details</code></h4></td> <td rowspan="2"><p>Additional details</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>array</code> <i>(comma-separated)</i>

<b>allowed values:</b><ul><li>count</li><li>percentage</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_reactions_ignored</code></h4></td> <td rowspan="2"><p>Ignored users</p> <p>Can be used to ignore bots activity</p> </td> </tr> <tr> <td nowrap="nowrap">⏩ Inherits <code>users_ignored</code>

<b>type:</b> <code>array</code> <i>(comma-separated)</i>

</td> </tr> </table> <!--/options-->

ℹ️ Examples workflows

<!--examples--> <!--/examples-->