2.3 KiB
🏦 Configure metrics for organizations
While metrics targets mainly user accounts, it's possible to render metrics for organization accounts.
*️⃣ Using metrics on organization
Setup is mostly the same as for user accounts. A personal access token from an user account is required excepted that read:org scope must be enabled, whether you are member of the target organization or not.
user option will need to be set to organization name instead.
Example: render metrics for github organization
- uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
user: github
💡 If your organization using single sign-on, you may need to authorize your personal token access
💡 Plugins supporting organizations account are labeled with
👥 Organizations. Note that rendering consume way more API requests and huge organization may not actually be able to use a given plugin.
💡 To support private repositories, add
reposcope
It is possible to host workflows in the .github repository of organizations, and display metrics on organization profiles.
*️⃣ Organizations memberships for user accounts
By default, GitHub only display public memberships.
Membership visibility canbe managed in the People tab of your organization.
⚠️ Seeing your organization membership in your profile does not mean that it is visible from other users! You can check this by viewing your profile in an private browser window.