sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

ci: auto-regenerate files

Browse Source
This commit is contained in:
github-actions[bot]
2022-01-16 14:34:52 +00:00
parent 8119ac9c47
commit 625bdadf73
3 changed files with 93 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -66,12 +66,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
<td align="center"> <td align="center">
<details open><summary>Recent activity charts</summary> <details open><summary>Recent activity charts</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.charts.svg" alt=""></img></details>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.charts.svg"> <details open><summary>Midly interesting facts</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.facts.svg" alt=""></img></details>
</details>
<details open><summary>Midly interesting facts</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.facts.svg">
</details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
</tr> </tr>
@@ -102,12 +98,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
<td align="center"> <td align="center">
<details open><summary>Related to an user</summary> <details open><summary>Related to an user</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.followers.svg" alt=""></img></details>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.followers.svg"> <details><summary>Related to a repository</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.repository.svg" alt=""></img></details>
</details>
<details><summary>Related to a repository</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.repository.svg">
</details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
</tr> </tr>
@@ -233,24 +225,14 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
</tr> </tr>
<tr> <tr>
<td align="center"> <td align="center">
<details open><summary>PageSpeed scores</summary> <details open><summary>PageSpeed scores</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.svg" alt=""></img></details>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.svg"> <details><summary>PageSpeed scores with detailed report</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.detailed.svg" alt=""></img></details>
</details> <details><summary>PageSpeed scores with a website screenshot</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.screenshot.svg" alt=""></img></details>
<details><summary>PageSpeed scores with detailed report</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.detailed.svg">
</details>
<details><summary>PageSpeed scores with a website screenshot</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.screenshot.svg">
</details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
<td align="center"> <td align="center">
<details open><summary>Random tracks from a playlist</summary> <details open><summary>Random tracks from a playlist</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.playlist.svg" alt=""></img></details>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.playlist.svg"> <details open><summary>Recently listened</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.recent.svg" alt=""></img></details>
</details>
<details open><summary>Recently listened</summary>
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.recent.svg">
</details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
</tr> </tr>
@@ -402,7 +384,7 @@ There are several ways to setup metrics, each having its advantages and disadvan
* [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md) * [🏗️ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md)
* ✔️ Create another shared instance * ✔️ Create another shared instance
* ➖ Requires some sysadmin knowlegde * ➖ Requires some sysadmin knowlegde
* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md) * [🐳 Using command line with docker *(~2 min)*](/.github/readme/partials/documentation/setup/docker.md)
* ✔️ Suited for one-time rendering * ✔️ Suited for one-time rendering
* [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md) * [🔧 Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md)

149
action.yml generated
View File

@@ -434,37 +434,34 @@ inputs:
# ==================================================================================== # ====================================================================================
# 💡 Coding habits # 💡 Coding habits
# Enable or disable plugin
plugin_habits: plugin_habits:
description: Display coding habits metrics description: Enable habits plugin
default: no default: no
# Number of events to use to computes habits
# Using more will result in more accurate metrics, but you may hit GitHub rate-limit more easily
plugin_habits_from: plugin_habits_from:
description: Number of events to use description: Events to use
default: 200 default: 200
# Filter used events to compute habits by age
plugin_habits_days: plugin_habits_days:
description: Maximum event age description: Event maximum age
default: 14 default: 14
# Display tidbits about your most active hours/days, indents used (spaces/tabs), etc.
# This is deduced from your recent activity
plugin_habits_facts: plugin_habits_facts:
description: Display coding habits collected facts based on recent activity description: Toggle midly interesting facts display
default: yes default: yes
# Display charts of most active time of the day and most active day of the week
# Also display languages recently used (this is not the same as plugin_languages, as the latter is an all-time stats)
plugin_habits_charts: plugin_habits_charts:
description: Display coding habits charts based on recent activity description: Toggle charts display
default: no default: no
# Trim unused hours on daily chart
plugin_habits_trim: plugin_habits_trim:
description: Trim unused hours on daily chart description: Trim unused hours on charts
default: no default: no
# ==================================================================================== # ====================================================================================
@@ -579,48 +576,44 @@ inputs:
# ==================================================================================== # ====================================================================================
# 🧑‍🤝‍🧑 People plugin # 🧑‍🤝‍🧑 People plugin
# Enable or disable plugin
plugin_people: plugin_people:
description: Display GitHub users from various affiliations description: Enable people plugin
default: no default: no
# Number of users to display per section
plugin_people_limit: plugin_people_limit:
description: Maximum number of user to display description: Display limit
default: 24 default: 24
# Size of displayed user's avatar
plugin_people_size:
description: Size of displayed GitHub users' avatars
default: 28
# List of section to display
# Ordering will be kept
plugin_people_types:
description: Affiliations to display
default: followers, following
# When displaying "thanks" section, specified users list will be displayed
# This is useful to craft "Special thanks" badges
plugin_people_thanks:
description: GitHub users to personally thanks
default: ""
# Add specified users to GitHub sponsors ("sponsors" must be specified in "plugin_people_types")
# This is useful to list sponsors from unsupported GitHub sponsors sources
plugin_people_sponsors_custom:
description: Custom GitHub sponsors
default: ""
# Use GitHub identicons instead of users' avatar (for privacy purposes)
plugin_people_identicons: plugin_people_identicons:
description: Use identicons instead of avatars description: Toggle identicons display
default: no default: no
# Shuffle users for varied outputs
# If "plugin_people_limit" is set, plugin will fetch up to 10 ten times limit to ensure output is different each time plugin_people_size:
description: Profile picture display size
default: 28
plugin_people_types:
description: Displayed sections (order is respected)
default: followers, following
plugin_people_thanks:
description: Special thanks
default: ""
plugin_people_sponsors_custom:
description: Custom sponsors
default: ""
plugin_people_shuffle: plugin_people_shuffle:
description: Shuffle users description: Shuffle data for varied output
default: no default: no
# ==================================================================================== # ====================================================================================
@@ -964,32 +957,27 @@ inputs:
# ==================================================================================== # ====================================================================================
# ⏱️ Website performances # ⏱️ Website performances
# Enable or disable plugin
plugin_pagespeed: plugin_pagespeed:
description: Display a website Google PageSpeed metrics description: Enable pagespeed plugin
default: no default: no
# Website to audit with PageSpeed
plugin_pagespeed_url: plugin_pagespeed_url:
description: Audited website description: Audited website
default: .user.website default: .user.website
# Display the following additional metrics from audited website:
# First Contentful Paint, Speed Index, Largest Contentful Paint, Time to Interactive, Total Blocking Time, Cumulative Layout Shift
# See https://web.dev/performance-scoring/ and https://googlechrome.github.io/lighthouse/scorecalc/ for more informations
plugin_pagespeed_detailed: plugin_pagespeed_detailed:
description: Detailed audit result description: Detailed results
default: no default: no
# Display a screenshot of audited website
# May increases significantly filesize
plugin_pagespeed_screenshot: plugin_pagespeed_screenshot:
description: Display a screenshot of your website description: Display a website screenshot
default: no default: no
# PageSpeed API token
# This is optional, but providing it will avoid hitting rate-limiter
# See https://developers.google.com/speed/docs/insights/v5/get-started for more informations
plugin_pagespeed_token: plugin_pagespeed_token:
description: PageSpeed token description: PageSpeed token
default: "" default: ""
@@ -997,59 +985,52 @@ inputs:
# ==================================================================================== # ====================================================================================
# 🎼 Music plugin # 🎼 Music plugin
# Enable or disable plugin
plugin_music: plugin_music:
description: Display your music tracks description: Enable music plugin
default: no default: no
# Name of music provider
# This is optional for "playlist" mode (it can be deduced automatically from "plugin_music_playlist" url)
# This is required in other modes
plugin_music_provider: plugin_music_provider:
description: Music provider description: Music provider
default: "" default: ""
# Music provider token
# This may be required depending on music provider used and plugin mode
# - "apple" : not required
# - "spotify" : required for "recent" or "top" mode, format is "client_id, client_secret, refresh_token"
# - "lastfm" : required, format is "api_key"
# - "youtube" : required for "recent" mode, format is "cookie"
plugin_music_token: plugin_music_token:
description: Music provider personal token description: Music provider token
default: "" default: ""
# Plugin mode
plugin_music_mode: plugin_music_mode:
description: Plugin mode description: Display mode
default: "" default: ""
# Embed playlist url (i.e. url used by music player iframes)
plugin_music_playlist: plugin_music_playlist:
description: Embed playlist url description: Playlist URL
default: "" default: ""
# Number of music tracks to display
plugin_music_limit: plugin_music_limit:
description: Maximum number of tracks to display description: Display limit
default: 4 default: 4
# Display when track was last played
plugin_music_played_at: plugin_music_played_at:
description: Display when the track was played description: Recently played - Toggle last played timestamp display
default: no default: no
# Time range for "top" mode
plugin_music_time_range: plugin_music_time_range:
description: Time period for top mode description: Top tracks - Time range for `top` mode
default: short default: short
# Option for "top" mode to select tracks or artists
plugin_music_top_type: plugin_music_top_type:
description: Whether to show tracks or artists in top mode description: Top tracks - Display type
default: tracks default: tracks
# Username on music provider service
plugin_music_user: plugin_music_user:
description: Music provider username description: Music provider username
default: .user.login default: .user.login

12
settings.example.json generated
View File

@@ -48,7 +48,7 @@
"enabled": false, "//": "Enable licenses plugin" "enabled": false, "//": "Enable licenses plugin"
}, },
"habits":{ "habits":{
"enabled": false, "//": "Display coding habits metrics" "enabled": false, "//": "Enable habits plugin"
}, },
"contributors":{ "contributors":{
"enabled": false, "//": "Enable contributors plugin" "enabled": false, "//": "Enable contributors plugin"
@@ -60,7 +60,7 @@
"enabled": false, "//": "Enable reactions plugin" "enabled": false, "//": "Enable reactions plugin"
}, },
"people":{ "people":{
"enabled": false, "//": "Display GitHub users from various affiliations" "enabled": false, "//": "Enable people plugin"
}, },
"stargazers":{ "stargazers":{
"enabled": false, "//": "Enable stargazers plugin" "enabled": false, "//": "Enable stargazers plugin"
@@ -111,12 +111,12 @@
"enabled": false, "//": "Enable skyline plugin" "enabled": false, "//": "Enable skyline plugin"
}, },
"pagespeed":{ "pagespeed":{
"token": null, "//":"PageSpeed token", "token": null, "//":"PageSpeed token\n\nAlthough not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See [PageSpeed documentation](https://developers.google.com/speed/docs/insights/v5/get-started) for more informations.\n",
"enabled": false, "//": "Display a website Google PageSpeed metrics" "enabled": false, "//": "Enable pagespeed plugin"
}, },
"music":{ "music":{
"token": null, "//":"Music provider personal token", "token": null, "//":"Music provider token\n\nBelow is the expected token format for each provider:\n- `apple`: *(not supported)*\n- `spotify`: \"client_id, client_secret, refresh_token\"\n- `lastfm`: \"api_key\"\n- `youtube`: \"cookie\"\n",
"enabled": false, "//": "Display your music tracks" "enabled": false, "//": "Enable music plugin"
}, },
"stackoverflow":{ "stackoverflow":{
"enabled": false, "//": "Enable stackoverflow plugin" "enabled": false, "//": "Enable stackoverflow plugin"