The great refactor (#82)
This commit is contained in:
48
.github/readme/partials/documentation/organizations.md
vendored
Normal file
48
.github/readme/partials/documentation/organizations.md
vendored
Normal file
@@ -0,0 +1,48 @@
|
||||
### 🏦 Organizations metrics
|
||||
|
||||
While metrics targets mainly user accounts, it's possible to render metrics for organization accounts.
|
||||
|
||||

|
||||
|
||||
<details>
|
||||
<summary>💬 Metrics for organizations</summary>
|
||||
|
||||
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**.
|
||||
|
||||

|
||||
|
||||
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](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on).
|
||||
|
||||
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
|
||||
|
||||
```yaml
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
# ... other options
|
||||
token: ${{ secrets.METRICS_TOKEN }} # A personal token from an user account with read:org scope
|
||||
committer_token: ${{ secrets.GITHUB_TOKEN }} # GitHub auto-generated token
|
||||
user: organization-name # Organization name
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>💬 Organizations memberships for user accounts</summary>
|
||||
|
||||
Only public memberships can be displayed by metrics by default.
|
||||
You can manage your membership visibility in the `People` tab of your organization:
|
||||
|
||||

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

|
||||
|
||||
|
||||
</details>
|
||||
Reference in New Issue
Block a user