Skip to content

Latest commit

 

History

History
91 lines (86 loc) · 2.89 KB

README.md

File metadata and controls

91 lines (86 loc) · 2.89 KB
← Back to plugins index

💝 GitHub Sponsorships

This plugin displays sponsorships funded through 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
👤 Users 👥 Organizations
🔑 read:user 🔑 read:org read:packages (optional) repo (optional)

➡️ Available options

OptionDescription

plugin_sponsorships

Enable sponsorships plugin

type: boolean
default: no

plugin_sponsorships_sections

Displayed sections

  • amount: display total amount sponsored
  • sponsorships: display GitHub sponsorships
type: array (comma-separated)
default: amount, sponsorships
allowed values:
  • amount
  • sponsorships

plugin_sponsorships_size

Profile picture display size

type: number (8 ≤ 𝑥 ≤ 64)
default: 24

ℹ️ Examples workflows

name: 💝 GitHub Sponsorships
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.sponsorships.svg
  token: ${{ secrets.METRICS_TOKEN_PERSONAL }}
  base: ""
  plugin_sponsorships: yes