Files
metrics/source/plugins/repositories/README.md
2022-01-22 04:16:53 +00:00

2.5 KiB
Raw Blame History

📓 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) repo (optional)

➡️ Available options

TypeDescription
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)

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