Files
metrics/source/plugins/traffic/README.md
2022-01-15 13:27:01 -05:00

1.6 KiB
Raw Blame History

🧮 Repositories traffic

⚠️ This plugin requires a personal token with repo scope.

The repositories traffic plugin displays the number of page views across your repositories.

Because of GitHub REST API limitation, provided token requires full repo scope to access traffic informations.

Token with repo scope

➡️ Available options

TypeDescription
plugin_traffic Display repositories traffic metrics
type: boolean
default: no
plugin_traffic_skipped Repositories to skip
Inherits repositories_skipped
type: array (comma-separated)

→ Full specification

Examples workflows

name: Repositories traffic
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.traffic.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: repositories
  plugin_traffic: 'yes'