Files
metrics/.github/readme/partials/documentation/organizations.md
2021-04-08 20:37:23 +02:00

1.9 KiB
Raw Blame History

🏦 Organizations metrics

While metrics targets mainly user accounts, it's possible to render metrics for organization accounts.

Metrics (organization account)

💬 Metrics for organizations (click to expand)

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
💬 Organizations memberships for user accounts (click to expand)

Only public memberships can be displayed by metrics by default. You can manage your membership visibility in the People tab of your organization:

Publish organization membership

For organization memberships, add read:org scope to your personal token.

Add read:org scope to personal token