metrics/source/plugins/repositories/README.md

← Back to plugins index
📓 Repositories
This plugin displays a list of chosen featured repositories. It is mostly intended for images that will be used outside of GitHub, since it is already possible to pin repositories on GitHub. ⚠️ People will not be able to click on it due to limitations of using SVG inside <img> tags.
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	List of featured repositories If no owner is specified, it will implicitly use the current account login
⏯️ Cannot be preset type: array (comma-separated)
plugin_repositories_pinned	Display pinned repositories
✨ On master/main type: number (0 ≤ 𝑥 ≤ 6) default: 0

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