← 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

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 ```yaml 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 ``` ```yaml name: Sponsors introduction uses: lowlighter/metrics@latest with: filename: metrics.plugin.sponsors.full.svg token: ${{ secrets.METRICS_TOKEN_WITH_SCOPES }} base: "" plugin_sponsors: yes ```