metrics/source/plugins/stargazers

← 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

🗝️ Obtaining a Google Maps API token

Some features like plugin_stagazers_worldmap require a Google Geocoding API token. Follow instructions from their documentation for more informations.

💳 A billing account is required to get a token. However a recurring monthly credit is offered which means you should not be charged if you don't exceed the free quota.

It is advised to set the quota limit at 1200 requests per day

Use at your own risk, metrics and its authors cannot be held responsible for anything charged.

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