Skip to content

Latest commit

 

History

History
86 lines (80 loc) · 2.7 KB

README.md

File metadata and controls

86 lines (80 loc) · 2.7 KB
Raw

💕 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 repo (optional)
GitHub sponsors card
GitHub sponsors full introduction

➡️ Available options

TypeDescription

plugin_sponsors

Enable sponsors plugin
type: boolean
default: no

plugin_sponsors_sections

Displayed sections

  • goal: display GitHub active goal
  • about: display GitHub sponsors introduction
type: array (comma-separated)
default: goal, about
allowed values:
  • goal
  • about

ℹ️ Examples workflows

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

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