Skip to content

Latest commit

 

History

History
116 lines (110 loc) · 3.83 KB

README.md

File metadata and controls

116 lines (110 loc) · 3.83 KB
Raw
← Back to plugins index

💕 GitHub Sponsors

This plugin displays sponsors and introduction text from GitHub sponsors.

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

OptionDescription

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

Display past sponsorships

This feature requires a token from target account, as past sponsorships are gathered from sponsors activity and is private data.

⚠️ Past sponsorships does not respect sponsors privacy because of current GitHub API limitations. This may be fixed in future releases.
type: boolean
default: no

plugin_sponsors_size

Profile picture display size
type: number (8 ≤ 𝑥 ≤ 64)
default: 24

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