🧑‍🤝‍🧑 People plugin

This plugin can display relationships with users, such as followers, sponsors, contributors, stargazers, watchers, members, etc.

Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
Related to a user
Related to a repository
## âžĄī¸ Available options
TypeDescription

plugin_people

Enable people plugin

type: boolean
default: no

plugin_people_limit

Display limit

type: number (0 ≤ đ‘Ĩ)
zero behaviour: disable
default: 24

plugin_people_identicons

Toggle identicons display

This can be used to mask user profile pictures for privacy

type: boolean
default: no

plugin_people_size

Profile picture display size

type: number (8 ≤ đ‘Ĩ ≤ 64)
default: 28

plugin_people_types

Displayed sections (order is respected)

User and organization accounts support the following values:

  • followers
  • following/followed
  • sponsoring/sponsored
  • sponsors
  • members (organization only)
  • thanks(to be configured with plugin_people_thanks) Repositories support the following values:
  • sponsors (same as owner sponsors)
  • contributors
  • stargazers
  • watchers
  • thanks(to be configured with plugin_people_thanks)
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

This list can be used to thank specific users

â¯ī¸ Cannot be preset
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
type: array (comma-separated)

plugin_people_shuffle

Shuffle data for varied output

This will fetch 10 times more data than plugin_people_limit to ensure output is always different

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 plugin_people_sponsors_custom: >- iamsainikhil, yutkat, KasparJohannesSchneider, ktnkk, tfSheol, haribo-io, marcreichel, OmaarElAmri, naveensrinivasan ```