Files
metrics/.github/readme/partials/documentation/organizations/setup.md
2021-04-11 10:03:44 +02:00

1.2 KiB
Raw Blame History

💬 Metrics for organizations

Setup is the same as for user accounts, though you'll need to add read:org scope, whether you're member of target organization or not.

Add read:org scope to personal token

You'll also need to set user option with your organization name.

If you're encounting errors and your organization is using single sign-on, try to authorize your personal token.

Most of plugins supported by user accounts will work with organization accounts, but note that rendering metrics for organizations consume way more APIs requests.

To support private repositories, add full repo scope to your personal token.

Example workflow

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    token: ${{ secrets.METRICS_TOKEN }}          # A personal token from an user account with read:org scope
    user: organization-name                      # Organization name