Files
metrics/source/plugins/stargazers/README.md
2022-01-25 21:17:27 -05:00

2.8 KiB
Raw Blame History

Stargazers over last weeks

This plugin displays your stargazers evolution across all of your repositories over the last two weeks.

Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users 👥 Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
Chartist charts
Classic charts

➡️ Available options

TypeDescription
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
On master/main
type: string
default: null
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