Skip to content

Latest commit

 

History

History
167 lines (162 loc) · 4.98 KB

README.md

File metadata and controls

167 lines (162 loc) · 4.98 KB
← Back to plugins index

🎭 Comment reactions

This plugin displays overall user reactions on recent issues, comments and discussions.

⚠️ Disclaimer

This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub. All product and company names are trademarks™ or registered® trademarks of their respective holders.

Supported features
→ Full specification
📗 Classic template
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)

➡️ Available options

OptionDescription

plugin_reactions

Enable reactions plugin

type: boolean
default: no

plugin_reactions_limit

Display limit (issues and pull requests comments)

type: number (0 ≤ 𝑥 ≤ 1000)
default: 200

plugin_reactions_limit_issues

Display limit (issues and pull requests, first comment)

type: number (0 ≤ 𝑥 ≤ 1000)
default: 100

plugin_reactions_limit_discussions

Display limit (discussions, first comment)

type: number (0 ≤ 𝑥 ≤ 1000)
default: 100

plugin_reactions_limit_discussions_comments

Display limit (discussions comments)

type: number (0 ≤ 𝑥 ≤ 1000)
default: 100

plugin_reactions_days

Comments maximum age

type: number (0 ≤ 𝑥)
zero behaviour: disable
default: 0

plugin_reactions_display

Display mode

  • absolute: scale percentages using total reactions count
  • relative: scale percentages using highest reaction count
type: string
default: absolute
allowed values:
  • absolute
  • relative

plugin_reactions_details

Additional details

type: array (comma-separated)
allowed values:
  • count
  • percentage

plugin_reactions_ignored

Ignored users

Can be used to ignore bots activity

⏩ Inherits users_ignored
type: array (comma-separated)

ℹ️ Examples workflows

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