Files
metrics/source/plugins/traffic/README.md
2021-04-10 14:21:53 +02:00

27 lines
716 B
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
### 🧮 Repositories traffic
> ⚠️ This plugin requires a personal token with repo scope.
The repositories *traffic* plugin displays the number of page views across your repositories.
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.traffic.svg">
</td>
</table>
Because of GitHub REST API limitation, provided token requires full `repo` scope to access traffic informations.
![Token with repo scope](/.github/readme/imgs/setup_token_repo_scope.png)
#### Examples workflows
[➡️ Available options for this plugin](metadata.yml)
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_traffic: yes
```