Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auto-regenerate files #82

Merged
merged 1 commit into from
Feb 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
72 changes: 32 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
<table>
<tr>
<th colspan="2" align="center">
<a href="source/plugins/README.md">🧩 23 plugins</a>
<a href="source/plugins/README.md">🧩 24 plugins</a>
</th>
</tr>
<tr>
Expand Down Expand Up @@ -141,40 +141,44 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
</td>
</tr>
<tr>
<th><a href="source/plugins/skyline/README.md">🌇 GitHub Skyline 3D calendar</a></th>
<th><a href="source/plugins/stargazers/README.md">✨ Stargazers over last weeks</a></th>
<th><a href="source/plugins/stars/README.md">🌟 Recently starred repositories</a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stargazers.svg">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.skyline.svg">
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stars.svg">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stargazers.svg">
<img width="900" height="1" alt="">
</td>
</tr>
<tr>
<th><a href="source/plugins/stars/README.md">🌟 Recently starred repositories</a></th>
<th><a href="source/plugins/topics/README.md">📌 Starred topics</a></th>
<th><a href="source/plugins/traffic/README.md">🧮 Repositories traffic</a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stars.svg">
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg">
<details open><summary>Mastered and known technologies version</summary>
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.mastered.svg">
</details>
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.traffic.svg">
</td>
</tr>
<tr>
<th><a href="source/plugins/traffic/README.md">🧮 Repositories traffic</a></th>
<th><a href="source/plugins/anilist/README.md">🌸 Anilist watch list and reading list</a></th>
<th><a href="source/plugins/music/README.md">🎼 Music plugin</a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.traffic.svg">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.anilist.svg">
<details><summary>Manga version</summary>
Expand All @@ -185,6 +189,12 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
</details>
<img width="900" height="1" alt="">
</td>
</tr>
<tr>
<th><a href="source/plugins/music/README.md">🎼 Music plugin</a></th>
<th><a href="source/plugins/pagespeed/README.md">⏱️ Website performances</a></th>
</tr>
<tr>
<td align="center">
<details open><summary>🎼 Favorite tracks version</summary>
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.music.playlist.svg">
Expand All @@ -194,12 +204,6 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
</details>
<img width="900" height="1" alt="">
</td>
</tr>
<tr>
<th><a href="source/plugins/pagespeed/README.md">⏱️ Website performances</a></th>
<th><a href="source/plugins/posts/README.md">✒️ Recent posts</a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.pagespeed.svg">
<details><summary>Detailed version</summary>
Expand All @@ -210,35 +214,34 @@ Generate your metrics that you can embed everywhere, including your GitHub profi
</details>
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg">
<img width="900" height="1" alt="">
</td>
</tr>
<tr>
<th><a href="source/plugins/posts/README.md">✒️ Recent posts</a></th>
<th><a href="source/plugins/tweets/README.md">🐤 Latest tweets</a></th>
<th><a href="source/plugins/wakatime/README.md">⏰ WakaTime plugin</a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.svg">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg">
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.wakatime.svg">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.tweets.svg">
<img width="900" height="1" alt="">
</td>
</tr>
<tr>
<th><a href="source/plugins/wakatime/README.md">⏰ WakaTime plugin</a></th>
<th><a href="source/plugins/nightscout/README.md">💉 Nightscout</a></th>
<th><a href="source/plugins//README.md"></a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.wakatime.svg">
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg">
<img width="900" height="1" alt="">
</td>
<td align="center"><img width="900" height="1" alt=""></td>
</tr>
<tr>
<th colspan="2" align="center">
Expand Down Expand Up @@ -534,22 +537,6 @@ systemctl status github_metrics

</details>

<details>
<summary>⚠️ HTTP errors code</summary>

Following error codes may be encountered on web instance:

| Error code | Description |
| ------------------------- | -------------------------------------------------------------------------- |
| `400 Bad request` | Invalid query (e.g. unsupported template) |
| `403 Forbidden` | User not allowed in `restricted` users list |
| `404 Not found` | GitHub API did not found the requested user |
| `429 Too many requests` | Thrown when rate limiter is trigerred |
| `500 Internal error` | Server error while generating metrics images (check logs for more details) |
| `503 Service unavailable` | Maximum user capacity reached, only cached images can be accessed for now |

</details>

<details>
<summary>🔗 HTTP parameters</summary>

Expand Down Expand Up @@ -595,6 +582,7 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1
<th nowrap="nowrap" align="center" title="👨‍💻 Lines of code changed">👨‍💻</th>
<th nowrap="nowrap" align="center" title="🧑‍🤝‍🧑 People plugin">🧑‍🤝‍🧑</th>
<th nowrap="nowrap" align="center" title="🗂️ Active projects">🗂️</th>
<th nowrap="nowrap" align="center" title="🌇 GitHub Skyline 3D calendar">🌇</th>
<th nowrap="nowrap" align="center" title="✨ Stargazers over last weeks">✨</th>
<th nowrap="nowrap" align="center" title="🌟 Recently starred repositories">🌟</th>
<th nowrap="nowrap" align="center" title="📌 Starred topics">📌</th>
Expand Down Expand Up @@ -622,6 +610,7 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1
<th nowrap="nowrap" align="center" data-plugin="lines">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="people">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="projects">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="skyline">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="stargazers">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="stars">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="topics">✔️</th>
Expand Down Expand Up @@ -649,6 +638,7 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1
<th nowrap="nowrap" align="center" data-plugin="lines">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="people">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="projects">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="skyline">❌</th>
<th nowrap="nowrap" align="center" data-plugin="stargazers">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="stars">❌</th>
<th nowrap="nowrap" align="center" data-plugin="topics">❌</th>
Expand Down Expand Up @@ -676,6 +666,7 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1
<th nowrap="nowrap" align="center" data-plugin="lines">✔️</th>
<th nowrap="nowrap" align="center" data-plugin="people">❌</th>
<th nowrap="nowrap" align="center" data-plugin="projects">❌</th>
<th nowrap="nowrap" align="center" data-plugin="skyline">❌</th>
<th nowrap="nowrap" align="center" data-plugin="stargazers">❌</th>
<th nowrap="nowrap" align="center" data-plugin="stars">❌</th>
<th nowrap="nowrap" align="center" data-plugin="topics">❌</th>
Expand Down Expand Up @@ -721,6 +712,7 @@ See their respective documentation for more informations about how to setup them
* [👨‍💻 Lines of code changed](/source/plugins/lines/README.md)
* [🧑‍🤝‍🧑 People plugin](/source/plugins/people/README.md)
* [🗂️ Active projects](/source/plugins/projects/README.md)
* [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md)
* [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md)
* [🌟 Recently starred repositories](/source/plugins/stars/README.md)
* [📌 Starred topics](/source/plugins/topics/README.md)
Expand Down
19 changes: 19 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,25 @@ inputs:
description: Display projects descriptions
default: no

# ====================================================================================
# 🌇 GitHub Skyline 3D calendar

# Enable or disable plugin
plugin_skyline:
description: Display GitHub Skyline 3D calendar
default: no

# Displayed year
plugin_skyline_year:
description: Displayed year
default: current-year

# Number of frames
# Use 120 for a full-loop and 60 for a half-loop
plugin_skyline_frames:
description: Number of frames
default: 60

# ====================================================================================
# ✨ Stargazers over last weeks

Expand Down
7 changes: 7 additions & 0 deletions settings.example.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
"mocked": false, "//": "Use mocked data instead of live APIs (use 'force' to use mocked token even if real token are defined)",
"repositories": 100, "//": "Number of repositories to use",
"padding": ["6%", "15%"], "//": "Image padding (default)",
"hosted": {
"by": "", "//": "Web instance host (displayed in footer)",
"link": "", "//": "Web instance host link (displayed in footer)"
},
"community": {
"templates": [], "//": "Additional community templates to setup"
},
Expand Down Expand Up @@ -58,6 +62,9 @@
"projects":{
"enabled": false, "//": "Display active projects"
},
"skyline":{
"enabled": false, "//": "Display GitHub Skyline 3D calendar"
},
"stargazers":{
"enabled": false, "//": "Display stargazers metrics"
},
Expand Down
1 change: 1 addition & 0 deletions source/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ See their respective documentation for more informations about how to setup them
* [👨‍💻 Lines of code changed](/source/plugins/lines/README.md)
* [🧑‍🤝‍🧑 People plugin](/source/plugins/people/README.md)
* [🗂️ Active projects](/source/plugins/projects/README.md)
* [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md)
* [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md)
* [🌟 Recently starred repositories](/source/plugins/stars/README.md)
* [📌 Starred topics](/source/plugins/topics/README.md)
Expand Down