metrics/source/plugins/stargazers/README.md

← Back to plugins index
✨ Stargazers over last weeks
This plugin displays stargazers evolution across affiliated repositories over the last two weeks.
Supported features → Full specification	📗 Classic template 📘 Repository template
	👤 Users 👥 Organizations 📓 Repositories
	🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Classic charts Chartist charts

➡️ Available options

Option	Description
plugin_stargazers	Enable stargazers plugin
type: boolean default: no
plugin_stargazers_charts_type	Charts display type classic: <div> based charts, simple and lightweight chartist: <svg> based charts, smooth
🌐 Web instances must configure settings.json: metrics.npm.optional.chartist type: string default: classic allowed values: classic chartist

ℹ️ Examples workflows

name: Using classic charts
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.stargazers.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_stargazers: yes

name: Using chartist charts
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.stargazers.chartist.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_stargazers: yes
  plugin_stargazers_charts_type: chartist