Skip to content

Latest commit

 

History

History
157 lines (151 loc) · 4.47 KB

README.md

File metadata and controls

157 lines (151 loc) · 4.47 KB

💫 Starlists

This plugin displays your star lists.

Supported features
→ Full specification
📗 Classic template
👤 Users
No tokens are required for this plugin
Repositories from star lists
Languages from star lists

➡️ Available options

TypeDescription

plugin_starlists

Enable starlists plugin

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

Toggle star list languages statistics

type: boolean
default: no

plugin_starlists_limit_languages

Disply limit (languages per star list)

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

plugin_starlists_shuffle_repositories

Shuffle data for varied outputs

type: boolean
default: yes

plugin_starlists_ignored

Skipped star lists

This is case and emojis insensitive

type: array (comma-separated)

plugin_starlists_only

Restrict display to specified star lists

This is case and emojis insensitive. This option is equivalent to plugin_starlists_ignored with all star lists but 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