← Back to plugins index

🏆 Achievements

This plugin displays several highlights about what an account has achieved on GitHub.

Supported features
→ Full specification		 📗 Classic template
👤 Users đŸ‘Ĩ Organizations
🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Compact display
Detailed display
## ➡ī¸ Available options
OptionDescription

plugin_achievements

Enable achievements plugin
🌐 Web instances must configure settings.json:
  • metrics.run.puppeteer.scrapping
type: boolean
default: no

plugin_achievements_threshold

Rank threshold filter

Use X to display achievements not yet unlocked
type: string
default: C
allowed values:
  • S
  • A
  • B
  • C
  • X

plugin_achievements_secrets

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 ≤ đ‘Ĩ)
zero behaviour: disable
default: 0

plugin_achievements_ignored

Ignored achievements

Use achievements names without their rank adjective (i.e. without "great", "super" or "master")
type: array (comma-separated)

plugin_achievements_only

Showcased achievements

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

This option is equivalent to plugin_achievements_ignored with all existing achievements except the ones listed in this option
type: array (comma-separated)
## ℹī¸ Examples workflows ```yaml 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 ``` ```yaml 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 ```