README - Metrics — ContextQMD

<table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>🏆 Achievements</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays several highlights about what an account has achieved on GitHub.</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 <sub><a href="metadata.yml">→ Full specification</a></sub></th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td> </tr> <tr> <td><code>👤 Users</code> <code>👥 Organizations</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"> <details open><summary>Compact display</summary></img></details> <details><summary>Detailed display</summary></img></details>

</td>

</tr> </table>

➡️ Available 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_achievements</code></h4></td> <td rowspan="2"><p>Enable achievements plugin</p> </td> </tr> <tr> <td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code>: <ul> <li><i>metrics.run.puppeteer.scrapping</i></li> </ul> <b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_achievements_threshold</code></h4></td> <td rowspan="2"><p>Rank threshold filter</p> <p>Use <code>X</code> to display achievements not yet unlocked</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>default:</b> C

<b>allowed values:</b><ul><li>S</li><li>A</li><li>B</li><li>C</li><li>X</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_achievements_secrets</code></h4></td> <td rowspan="2"><p>Secrets achievements</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> yes

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_achievements_display</code></h4></td> <td rowspan="2"><p>Display style</p> <ul> <li><code>detailed</code>: display icon, name, description and ranking</li> <li><code>compact</code>: display icon, name and value</li> </ul> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>default:</b> detailed

<b>allowed values:</b><ul><li>detailed</li><li>compact</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_achievements_limit</code></h4></td> <td rowspan="2"><p>Display limit</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_achievements_ignored</code></h4></td> <td rowspan="2"><p>Ignored achievements</p> <p>Use achievements names without their rank adjective (i.e. without "great", "super" or "master")</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>array</code> <i>(comma-separated)</i> </td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_achievements_only</code></h4></td> <td rowspan="2"><p>Showcased achievements</p> <p>Use achievements names without their rank adjective (i.e. without "great", "super" or "master")</p> <p>This option is equivalent to <a href="/source/plugins/achievements/README.md#plugin_achievements_ignored"><code>plugin_achievements_ignored</code></a> with all existing achievements except the ones listed in this option</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>array</code> <i>(comma-separated)</i> </td> </tr> </table>

ℹ️ 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