Skip to content

Latest commit

 

History

History
147 lines (141 loc) · 4.72 KB

README.md

File metadata and controls

147 lines (141 loc) · 4.72 KB

🏆 Achievements

This plugin displays several highlights about what you achieved on GitHub.

Supported features
→ Full specification
📗 Classic template
👤 Users 👥 Organizations
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
Compact display
Detailed display

➡️ Available options

TypeDescription
plugin_achievements

Enable achievements plugin

type: boolean
default: no
plugin_achievements_threshold

Display rank threshold

Use X to display achievements not yet unlocked

type: string
default: C
allowed values:
  • S
  • A
  • B
  • C
  • X
plugin_achievements_secrets

Display secrets achievements

type: boolean
default: yes
plugin_achievements_display

Display style

  • detailed: display icon, name, description and ranking
  • compact: display icon, name and value
type: string
default: detailed
allowed values:
  • detailed
  • compact
plugin_achievements_limit

Display limit

type: number (0 ≤ 𝑥)
default: 0
plugin_achievements_ignored

Hide specified achievements

Use names without the rank adjective (i.e. without "great", "super" or "master")

type: array (comma-separated)
plugin_achievements_only

Restrict display to specified achievements

Use names without the rank adjective (i.e. without "great", "super" or "master")

This option is equivalent to plugin_achievements_ignored with all existing achievements but the ones listed in this option

type: array (comma-separated)

ℹ️ Examples workflows

name: Detailed display
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.achievements.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_achievements: yes
  plugin_achievements_only: sponsor, maintainer, octonaut
name: Compact display
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.achievements.compact.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_achievements: yes
  plugin_achievements_only: >-
    polyglot, stargazer, sponsor, deployer, member, maintainer, developer,
    scripter, packager, explorer, infographile, manager
  plugin_achievements_display: compact
  plugin_achievements_threshold: X