metrics/source/plugins/traffic/README.md

🧮 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.

➡️ Available options

Option	Type (format) [default] {allowed values}	Description
plugin_traffic	boolean [no]	Display repositories traffic metrics
plugin_traffic_skipped	array (comma-separated) []	Repositories to skip

Legend for option icons:

• 🔐 Value should be stored in repository secrets
• ✨ New feature currently in testing on master/main

→ 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'