metrics/source/plugins/starlists/README.md

← Back to plugins index
💫 Star lists
This plugin displays star lists.
⚠️ 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
	No tokens are required for this plugin
Repositories from star lists Languages from star lists

➡️ Available options

Option	Description
plugin_starlists	Enable starlists plugin
🌐 Web instances must configure settings.json: metrics.run.puppeteer.scrapping type: boolean default: no
plugin_starlists_limit	Display limit (star lists)
type: number (1 ≤ 𝑥 ≤ 100) default: 2
plugin_starlists_limit_repositories	Display limit (repositories per star list)
type: number (0 ≤ 𝑥 ≤ 100) default: 2
plugin_starlists_languages	Star lists languages statistics
type: boolean default: no
plugin_starlists_limit_languages	Display limit (languages per star list)
type: number (0 ≤ 𝑥) zero behaviour: disable default: 8
plugin_starlists_shuffle_repositories	Shuffle data Can be used to create varied outputs
type: boolean default: yes
plugin_starlists_ignored	Skipped star lists Case and emojis insensitive
type: array (comma-separated)
plugin_starlists_only	Showcased star lists Case and emojis insensitive. Equivalent to plugin_starlists_ignored with all star lists except the ones listed in this option
type: array (comma-separated)

ℹ️ Examples workflows

name: Featured star list
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.starlists.svg
  token: NOT_NEEDED
  base: ""
  plugin_starlists: yes
  plugin_starlists_limit_repositories: 2
  plugin_starlists_only: TC39

name: Featured star list languages
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.starlists.languages.svg
  token: NOT_NEEDED
  base: ""
  plugin_starlists: yes
  plugin_starlists_languages: yes
  plugin_starlists_limit_languages: 8
  plugin_starlists_limit_repositories: 0
  plugin_starlists_only: Awesome