Skip to content

Latest commit

 

History

History
56 lines (47 loc) · 3.05 KB

README.md

File metadata and controls

56 lines (47 loc) · 3.05 KB

🧑‍🤝‍🧑 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.

Followed people version
Special thanks version
Repository template version

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.

ℹ️ Examples workflows

➡️ Available options for this plugin

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_people: yes
    plugin_people_types: followers, thanks     # Display followers and "thanks" sections
    plugin_people_limit: 28                    # Limit to 28 entries per section
    plugin_people_size: 28                     # Size in pixels of displayed avatars
    plugin_people_identicons: no               # Use avatars (do not use identicons)
    plugin_people_thanks: lowlighter, octocat  # Users that will be displayed in "thanks" section
    plugin_people_sponsors_custom: octocat     # Users that will be displayed additionally in "sponsors" section
    plugin_people_shuffle: yes                 # Shuffle for varied output