@@ -16,6 +16,8 @@ Its `README.md` will be displayed on your user profile:
|
||||
|
||||
## 1️ Create a GitHub personal token
|
||||
|
||||
> 💡 A GitHub personal token is required since this action will fetch data that cannot be accessed through repository-scoped tokens (like [`${{ secrets.GITHUB_TOKEN }}` or `${{ github.token }}`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)) such as users, organizations, issues, pull requests, comments, commits, activity, etc.
|
||||
|
||||
From the `Developer settings` of your account settings, select `Personal access tokens` to create a new token.
|
||||
|
||||
No scopes are required, but additional one may be required depending on which features will be used. Each plugin documentation enumerates which scopes are required to make it work.
|
||||
@@ -65,17 +67,21 @@ on:
|
||||
jobs:
|
||||
github-metrics:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.METRICS_TOKEN }}
|
||||
```
|
||||
|
||||
Rendered metrics will be committed to repository on each run.
|
||||
Default output action is to commit rendered metrics to target repository on each run.
|
||||
|
||||

|
||||

|
||||
|
||||
Use [`output_action`](/source/plugins/core/README.md#-configuring-output-action) to change this behaviour to use either pull requests, gists or manually handle renders.
|
||||
|
||||
### 3️.1️ Choosing between `@latest`, `@master`/`@main`, a fork or a pinned version
|
||||
|
||||
There are several *metrics* versions that can be used in workflows:
|
||||
|
||||
Reference in New Issue
Block a user