Add people plugin (#48)

This commit is contained in:
Simon Lecoq
2021-01-11 18:58:00 +01:00
committed by GitHub
parent c5723ad7f3
commit 4ef1b7367b
12 changed files with 279 additions and 7 deletions

View File

@@ -164,7 +164,7 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
</tr>
<tr>
<th><a href="https://github.com/lowlighter/metrics#-gists">🎫 Gists plugin</a></th>
<th><a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">🗃️ Header special features</a></th>
<th><a href="https://github.com/lowlighter/metrics#-people">🧑‍🤝‍🧑 People plugin <sup><code>🚧 @master</code></sup></a></th>
</tr>
<tr>
<td>
@@ -172,11 +172,28 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.gists.svg" alt="" width="400">
</a>
</td>
<td>
<a href="https://github.com/lowlighter/metrics#-people">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.followers.svg" alt="" width="400">
</a>
<details><summary>Followed people version</summary>
<a href="https://github.com/lowlighter/metrics#-habits">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.following.svg" alt="" width="400">
</a>
</details>
</td>
</tr>
<tr>
<th><a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">🗃️ Header special features</a></th>
<th></th>
</tr>
<tr>
<td>
<a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.header.svg" alt="" width="400">
</a>
</td>
<td></td>
</tr>
<tr>
<td colspan="2" align="center">
@@ -534,6 +551,7 @@ Used template defaults to the `classic` one.
<th><span title="Stars">🌟</span></th>
<th><span title="Stargazers">✨</span></th>
<th><span title="Gists">🎫</span></th>
<th><span title="People">🧑‍🤝‍🧑</span></th>
</tr>
<tr>
<th>Classic</th>
@@ -550,10 +568,11 @@ Used template defaults to the `classic` one.
<td data-for="tweets">✔️</td>
<td data-for="posts">✔️</td>
<td data-for="habits">✔️</td>
<th><span title="Available on @master">✔️<sup>M</sup></span></th>
<td data-for="activity"><span title="Available on @master">✔️<sup>M</sup></span></td>
<td data-for="stars">✔️</td>
<td data-for="stargazers">✔️</td>
<td data-for="gists">✔️</td>
<td data-for="people"><span title="Available on @master">✔️<sup>M</sup></span></td>
</tr>
<tr>
<th>Terminal</th>
@@ -574,6 +593,7 @@ Used template defaults to the `classic` one.
<td data-for="stars">❌</td>
<td data-for="stargazers">❌</td>
<td data-for="gists">✔️</td>
<td data-for="people">❌</td>
</tr>
<tr>
<th>Repository<sup>R</sup></th>
@@ -594,6 +614,7 @@ Used template defaults to the `classic` one.
<td data-for="stars">❌</td>
<td data-for="stargazers">✔️</td>
<td data-for="gists">❌</td>
<td data-for="people">❌</td>
</tr>
</table>
@@ -1381,6 +1402,41 @@ Add the following to your workflow :
</details>
### 🧑‍🤝‍🧑 People
🚧 This plugin is available as pre-release on @master branch (unstable)
The *people* plugin displays your followers and followed users' avatars.
![People plugin](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.people.svg)
<details>
<summary>💬 About</summary>
It will consume an additional GitHub request per group of 100 users fetched.
Add the following to your workflow :
```yaml
- uses: lowlighter/metrics@master
with:
# ... other options
plugin_people: yes
plugin_people_types: followers, following
plugin_people_limit: 28
plugin_people_size: 28 # Size in pixels of displayed avatars
```
It is possible to use [identicons](https://github.blog/2013-08-14-identicons/) instead of their avatar for privacy purposes.
```yaml
- uses: lowlighter/metrics@master
with:
# ... other options
plugin_people_identicons: yes
```
</details>
### 🔧 Other options
A few additional options are available.