test(plugins/community/splatoon): add to workflows

This commit is contained in:
lowlighter
2022-11-20 23:51:28 -05:00
parent 61bd91cec1
commit 41a6562dc9
13 changed files with 178 additions and 5 deletions

View File

@@ -53,5 +53,6 @@ Plugins provide additional content and lets you customize rendered metrics.
* [💉 Nightscout <sub>`nightscout`</sub>](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars)
* [💩 PoopMap plugin <sub>`poopmap`</sub>](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat)
* [📸 Website screenshot <sub>`screenshot`</sub>](/source/plugins/community/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter)
* [🦑 Splatoon <sub>`splatoon`</sub>](/source/plugins/community/splatoon/README.md) by [@lowlighter](https://github.com/lowlighter)
* [💹 Stock prices <sub>`stock`</sub>](/source/plugins/community/stock/README.md) by [@lowlighter](https://github.com/lowlighter)

View File

@@ -30,17 +30,27 @@
</td>
</tr> <tr>
<th><a href="/source/plugins/community/screenshot/README.md">📸 Website screenshot</a></th>
<th><a href="/source/plugins/community/stock/README.md">💹 Stock prices</a></th>
<th><a href="/source/plugins/community/splatoon/README.md">🦑 Splatoon</a></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.splatoon.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="/source/plugins/community/stock/README.md">💹 Stock prices</a></th>
<th></th>
</tr>
<tr>
<td align="center">
<img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
<td align="center"><img width="900" height="1" alt=""></td>
</tr>
</table>

View File

@@ -1,9 +1,108 @@
<!--header-->
<table>
<tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr>
<tr><th colspan="2"><h3>🦑 Splatoon</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin displays your Splatoon 3 recent matches based on data fetched from Splatnet.</p>
</td></tr>
<tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://www.nintendo.com">Nintendo</a> or <a href="https://splatoon.nintendo.com">Splatoon</a>.
All product and company names are trademarks™ or registered® trademarks of their respective holders.</p>
<p>This specific plugin is licensed under GPL-3.0 rather than MIT to comply with <a href="https://github.com/spacemeowx2/s3si.ts">spacemeowx2/s3si.ts</a> license.</p>
<p>Note that <em>Nintendo Switch Online</em> web tokens usage are not explicitly allowed by <em>Nintendo</em>, use at your own risk.</p>
</td></tr>
<tr><th>Authors</th><td><a href="https://github.com/lowlighter">@lowlighter</a></td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code></td>
</tr>
<tr>
<td><code>🗝️ plugin_splatoon_token</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.splatoon.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
## ➡️ Available options
<!--options-->
<table>
<tr>
<td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_splatoon</code></h4></td>
<td rowspan="2"><p>Enable splatoon plugin</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>boolean</code>
<br>
<b>default:</b> no<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_splatoon_token</code></h4></td>
<td rowspan="2"><p>Splatnet token</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
<td nowrap="nowrap">🔐 Token<br>
✨ On <code>master</code>/<code>main</code><br>
🌐 Web instances must configure <code>settings.json</code>:
<ul>
<li><i>metrics.api.nintendo.splatnet</i></li>
</ul>
<b>type:</b> <code>token</code>
<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_splatoon_modes</code></h4></td>
<td rowspan="2"><p>Displayed modes</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>array</code>
<i>(comma-separated)</i>
<br>
<b>default:</b> turf-war, splat-zones, tower-control, rainmaker, clam-blitz, salmon-run<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_splatoon_versus_limit</code></h4></td>
<td rowspan="2"><p>Display limit (Versus)</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 ≤
𝑥
≤ 6)</i>
<br>
<b>default:</b> 1<br></td>
</tr>
<tr>
<td nowrap="nowrap"><h4><code>plugin_splatoon_salmon_limit</code></h4></td>
<td rowspan="2"><p>Display limit (Salmon run)</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 ≤
𝑥
≤ 6)</i>
<br>
<b>default:</b> 1<br></td>
</tr>
</table>
<!--/options-->
## 🗝️ Obtaining a *Nintendo Switch Online* token
@@ -22,4 +121,17 @@ deno run --allow-run=deno --allow-read=profile.json --allow-write=profile.json -
## Examples workflows
<!--examples-->
```yaml
name: Example
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.splatoon.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ""
plugin_splatoon: yes
plugin_splatoon_token: ${{ secrets.SPLATOON_TOKEN }}
extras_css: |
h2 { display: none !important; }
```
<!--/examples-->

View File

@@ -6,7 +6,7 @@
base: ""
plugin_splatoon: yes
plugin_splatoon_token: ${{ secrets.SPLATOON_TOKEN }}
extras_css: |
h2 { display: none !important; }
test:
skip: true
prod:
skip: true