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-07-21 04:39:07 +00:00
parent aa83b84522
commit 31e289b8af
6 changed files with 186 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
source/plugins/habits/README.md
View File

@@ -140,6 +140,17 @@ Recent language activity may also displayed (it requires extras features to be e
<b>zero behaviour:</b> disable</br>
<b>default:</b> 8<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_habits_languages_threshold</code></h4></td>
<td rowspan="2"><p>Display threshold (percentage)</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>string</code>
<br>
<b>default:</b> 0%<br></td>
</tr>
</table>
<!--/options-->

49
source/plugins/skyline/README.md
View File

@@ -102,6 +102,35 @@ Using this mode significantly increase file size as each frame is encoded separa
<br>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_skyline_settings</code></h4></td>
<td rowspan="2"><p>Advanced settings</p>
<p>Can be configured to use alternate skyline websites different from <a href="https://skyline.github.com">skyline.github.com</a>, such as <a href="https://github.com/honzaap/GitHubCity">honzaap&#39;s GitHub City</a>.</p>
<ul>
<li><code>url</code>: Target URL (mandatory)</li>
<li><code>ready</code>: Readiness condition (A JS function that returns a boolean)</li>
<li><code>wait</code>: Time to wait after readiness condition is met (in seconds)</li>
<li><code>hide</code>: HTML elements to hide (A CSS selector)</li>
</ul>
<p>For <code>url</code> and <code>ready</code> options, <code>${login}</code> and <code>${year}</code> will be respectively templated to user&#39;s login and specified year</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
🌐 Web instances must configure <code>settings.json</code>:
<ul>
<li><i>metrics.run.puppeteer.user.js</i></li>
</ul>
<b>type:</b> <code>json</code>
<br>
<b>default:</b> {
"url": "https://skyline.github.com/${login}/${year}",
"ready": "[...document.querySelectorAll('span')].map(span => span.innerText).includes('Share on Twitter')",
"wait": 1,
"hide": "button, footer, a"
}
<br></td>
</tr>
</table>
<!--/options-->
@@ -120,5 +149,25 @@ with:
plugin_skyline_frames: 6
plugin_skyline_quality: 1
```
```yaml
name: GitHub City
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.skyline.city.svg
token: NOT_NEEDED
base: ""
plugin_skyline: yes
plugin_skyline_year: 2020
plugin_skyline_frames: 6
plugin_skyline_quality: 1
plugin_skyline_settings: |
{
"url": "https://honzaap.github.io/GithubCity?name=${login}&year=${year}",
"ready": "[...document.querySelectorAll('.display-info span')].map(span => span.innerText).includes('${login}')",
"wait": 4,
"hide": ".github-corner, .footer-link, .buttons-options, .mobile-rotate, .display-info span:first-child"
}
```
<!--/examples-->

58
source/plugins/stargazers/README.md
View File

@@ -12,12 +12,13 @@
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
</tr>
<tr>
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>read:packages (optional)</code> <code>repo (optional)</code></td>
<td><code>🔑 (scopeless)</code> <code>🗝️ plugin_stargazers_worldmap_token</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>read:packages (optional)</code> <code>repo (optional)</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<details open><summary>Classic charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg" alt=""></img></details>
<details><summary>Chartist charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg" alt=""></img></details>
<details open><summary>Worldmap</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.worldmap.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
</tr>
@@ -71,6 +72,48 @@ Follow instructions from their [documentation](https://developers.google.com/map
<b>default:</b> classic<br>
<b>allowed values:</b><ul><li>classic</li><li>chartist</li></ul></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_stargazers_worldmap</code></h4></td>
<td rowspan="2"><p>Stargazers worldmap</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
🌐 Web instances must configure <code>settings.json</code>:
<ul>
<li><i>metrics.api.google.maps</i></li>
</ul>
<b>type:</b> <code>boolean</code>
<br>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_stargazers_worldmap_token</code></h4></td>
<td rowspan="2"><p>Stargazers worldmap token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>token</code>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_stargazers_worldmap_sample</code></h4></td>
<td rowspan="2"><p>Stargazers worldmap sample</p>
<p>Use this setting to randomly sample and limit your stargazers.
Helps to avoid consuming too much Google Geocoding API requests while still being representative.</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>number</code>
<i>(0 ≤
𝑥)</i>
<br>
<b>zero behaviour:</b> disable</br>
<b>default:</b> 0<br></td>
</tr>
</table>
<!--/options-->
@@ -97,5 +140,18 @@ with:
plugin_stargazers: yes
plugin_stargazers_charts_type: chartist
```
```yaml
name: With worldmap
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.stargazers.worldmap.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_stargazers: yes
plugin_stargazers_worldmap: yes
plugin_stargazers_worldmap_token: ${{ secrets.GOOGLE_MAP_TOKEN }}
plugin_stargazers_worldmap_sample: 200
```
<!--/examples-->