Files
github-repository-stats-action/README.md
julien Lengrand-Lambert 4edcfdabc7 Feat/grabbing repo stats (#1)
* First version of working action, sending data to server.
* Adds daily cron job
2023-06-29 13:27:09 +02:00

1.4 KiB

GitHub repository statistics

This action grabs repository traffic from GitHub and send them to Repo Insights.

The main idea here is to get over the limitation of Github's traffic view, which only shows the last 14 days of traffic.

Inputs

access-token

Required The action requires a GitHub access token with write access to the repository. You can create one here.

Note: Make sure to add the token to your repository secrets and not to hardcode it in your workflow.

server-url

The URL of the Repo Insights server to send the data to. Used only for internal testing, and should not be used in production. Defaults to https://www.repoinsights.com/.

Outputs

payload

Payload contains all the data grabbed from the GitHub API and sent to the website.

Example usage

uses: actions/github-repository-stats-action
with:
  who-to-greet: 'Bob de Bouwer'

License

See the LICENSE file for license rights and limitations.

Author