metrics/source/plugins/people/README.md

🧑‍🤝‍🧑 People plugin

The people plugin can display people you're following or sponsoring, and also users who're following or sponsoring you. In repository mode, it's possible to display sponsors, stargazers, watchers.

Related to an user Related to a repository

The following types are supported:

Type	Alias	User metrics	Repository metrics
followers		✔️	❌
following	followed	✔️	❌
sponsoring	sponsored, sponsorshipsAsSponsor	✔️	❌
sponsors	sponsorshipsAsMaintainer	✔️	✔️
contributors		❌	✔️
stargazers		❌	✔️
watchers		❌	✔️
thanks		✔️	✔️
members		✔️ (organization)	❌

Sections will be ordered the same as specified in plugin_people_types. sponsors for repositories will output the same as the owner's sponsors.

➡️ Available options

Type	Description
plugin_people	Display GitHub users from various affiliations
type: boolean default: no
plugin_people_limit	Maximum number of user to display
type: number (0 ≤ 𝑥) default: 24
plugin_people_size	Size of displayed GitHub users' avatars
type: number (8 ≤ 𝑥 ≤ 64) default: 28
plugin_people_types	Affiliations to display
type: array (comma-separated) default: followers, following allowed values: followers following followed sponsoring members sponsored sponsors contributors stargazers watchers thanks
plugin_people_thanks	GitHub users to personally thanks
type: array (comma-separated)
plugin_people_sponsors_custom	Custom GitHub sponsors
type: array (comma-separated)
plugin_people_identicons	Use identicons instead of avatars
type: boolean default: no
plugin_people_shuffle	Shuffle users
type: boolean default: no

→ Full specification

ℹ️ Examples workflows

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

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