| ← Back to plugins index |
🧑🤝🧑 People |
|---|
This plugin can display relationships with users, such as followers, sponsors, contributors, stargazers, watchers, members, etc.
|
| ⚠️ Disclaimer | This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub.
All product and company names are trademarks™ or registered® trademarks of their respective holders.
|
|---|
Supported features
→ Full specification |
📗 Classic template 📘 Repository template |
👤 Users 👥 Organizations 📓 Repositories |
🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional) |
Related to a user Related to a repository ![]()
|
## ➡️ Available options
| Option | Description |
plugin_people
|
Enable people plugin
![]() |
✨ On master/main
type: boolean
default: no
|
plugin_people_limit
|
Display limit
![]() |
✨ On master/main
type: number
(0 ≤
𝑥)
zero behaviour: disable
default: 24
|
plugin_people_identicons
|
Force identicons pictures
Can be used to mask profile pictures for privacy
![]() |
✨ On master/main
type: boolean
default: no
|
plugin_people_identicons_hide
|
Hide identicons pictures
Can be used to mask users without a personal profile picture.
When used with plugin_people_identicons, users without a personal profile picture will still be filtered out, but their picture will be replaced by an identicon instead
![]() |
✨ On master/main
type: boolean
default: no
|
plugin_people_size
|
Profile picture display size
![]() |
✨ On master/main
type: number
(8 ≤
𝑥
≤ 64)
default: 28
|
plugin_people_types
|
Displayed sections
User and organization accounts support the following values:
followersfollowing/followedsponsoring/sponsoredsponsorsmembers (organization only)thanks(to be configured with plugin_people_thanks)
Repositories support the following values:
sponsors (same as owner sponsors)contributorsstargazerswatchersthanks(to be configured with plugin_people_thanks)
Specified order is honored
![]() |
✨ On master/main
type: array
(comma-separated)
default: followers, following
allowed values:- followers
- following
- followed
- sponsoring
- members
- sponsored
- sponsors
- contributors
- stargazers
- watchers
- thanks
|
plugin_people_thanks
|
Special thanks
Can be used to thank specific users
![]() |
⏯️ Cannot be preset
✨ On master/main
type: array
(comma-separated)
|
plugin_people_sponsors_custom
|
Custom sponsors
This list can be used to add users from unsupported GitHub sponsors sources.
The option plugin_people_types must contain the sponsors section in order for this setting to be effective
![]() |
⏯️ Cannot be preset
✨ On master/main
type: array
(comma-separated)
|
plugin_people_shuffle
|
Shuffle data
Can be used to create varied outputs
This will fetch additional data (10 times plugin_people_limit) to ensure output is always different
![]() |
✨ On master/main
type: boolean
default: no
|
## ℹ️ Examples workflows
```yaml
name: Followers
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.people.followers.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_people: yes
plugin_people_types: followers
```
```yaml
name: Contributors and sponsors
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.people.repository.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
template: repository
repo: metrics
plugin_people: yes
plugin_people_types: contributors, stargazers, watchers, sponsors
```