README.md

← Back to plugins index
📓 Featured repositories
This plugin displays a list of chosen featured repositories. Since it is possible to pin repositories on GitHub, this plugin is mostly intended for external usage.
⚠️ 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.
ℹ Additional notes	⚠️ Due to limitations of using SVG images inside <img> tags, clicking on a repository card will not redirect to repository page.
Supported features → Full specification	📗 Classic template
	👤 Users 👥 Organizations
	🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Featured Pinned

➡️ Available options

Option	Description
plugin_repositories	Enable repositories plugin
type: boolean default: no
plugin_repositories_featured	Featured repositories Current user will be used when no owner is specified
⏯️ Cannot be preset type: array (comma-separated)
plugin_repositories_pinned	Pinned repositories
type: number (0 ≤ 𝑥 ≤ 6) default: 0
plugin_repositories_starred	Featured most starred repositories
type: number (0 ≤ 𝑥 ≤ 100) default: 0
plugin_repositories_random	Featured random repositories
type: number (0 ≤ 𝑥 ≤ 100) default: 0
plugin_repositories_order	Featured repositories display order
type: array default: featured, pinned, starred, random allowed values: featured pinned starred random
plugin_repositories_forks	Include repositories forks
type: boolean default: no
plugin_repositories_affiliations	Repositories affiliations owner: owned repositories collaborator: repositories with push access organization_member: repositories from an organization where user is a member Set to "" to disable and fetch all repositories related to given account. This option changes which repositories will be fetched by plugin_repositories_starred and plugin_repositories_random options
type: array (comma-separated) default: owner allowed values: owner collaborator organization_member

ℹ️ Examples workflows

name: Featured repositories
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.repositories.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_repositories: yes
  plugin_repositories_featured: lowlighter/metrics

name: Pinned repositories
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.repositories.pinned.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_repositories: yes
  plugin_repositories_pinned: 2