README.md

← Back to plugins index
💕 GitHub Sponsors
This plugin displays sponsors and introduction text from GitHub sponsors.
⚠️ 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 📘 Repository template
	👤 Users 👥 Organizations 📓 Repositories
	🔑 read:user 🔑 read:org read:packages (optional) repo (optional)
GitHub sponsors card GitHub sponsors full introduction

➡️ Available options

Option	Description
plugin_sponsors	Enable sponsors plugin
type: boolean default: no
plugin_sponsors_sections	Displayed sections goal: display GitHub active goal about: display GitHub sponsors introduction list: display GitHub sponsors list
type: array (comma-separated) default: goal, list, about allowed values: goal about list
plugin_sponsors_past	Past sponsorships A token from target user must be specified to use this feature, as past sponsorships are gathered from sponsors activity which is private data. ⚠️ Past sponsorships does not respect sponsors privacy because of current GitHub API limitations. This may be fixed in a future release.
type: boolean default: no
plugin_sponsors_size	Profile picture display size
type: number (8 ≤ 𝑥 ≤ 64) default: 24
plugin_sponsors_title	Title caption
✨ On master/main type: string default: Sponsor Me!

ℹ️ Examples workflows

name: Sponsors goal
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.sponsors.svg
  token: ${{ secrets.METRICS_TOKEN_PERSONAL }}
  base: ""
  plugin_sponsors: yes
  plugin_sponsors_sections: goal, list
  plugin_sponsors_past: yes

name: Sponsors introduction
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.sponsors.full.svg
  token: ${{ secrets.METRICS_TOKEN_WITH_SCOPES }}
  base: ""
  plugin_sponsors: yes