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

docs: update metadata.yml where token isn't needed

Browse Source
This commit is contained in:
lowlighter
2022-01-27 20:09:26 -05:00
parent 65aeac2954
commit b1906e3de8
20 changed files with 43 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
.github/workflows/examples.yml vendored
View File

@@ -203,7 +203,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.topics.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_topics: yes
plugin_topics_limit: 12
@@ -216,7 +216,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.topics.icons.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_topics: yes
plugin_topics_limit: 0
@@ -673,7 +673,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.starlists.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_starlists: yes
plugin_starlists_limit_repositories: 2
@@ -834,7 +834,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.stackoverflow.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_stackoverflow: yes
plugin_stackoverflow_user: 1
@@ -927,7 +927,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.posts.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_posts: yes
plugin_posts_source: dev.to
@@ -940,7 +940,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.posts.full.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_posts: yes
plugin_posts_source: dev.to
@@ -997,7 +997,7 @@ jobs:
uses: lowlighter/metrics@master
with:
filename: metrics.plugin.screenshot.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_screenshot: yes
plugin_screenshot_title: XKCD of the day

10
source/plugins/community/README.md
View File

@@ -2,8 +2,8 @@
<tr><th colspan="2"><h3>🎲 Community plugins</h3></th></tr>
<tr><td colspan="2" align="center">Additional plugins maintained by community for even more features!</td></tr>
<tr>
<th><a href="source/plugins/community/fortune/README.md">🥠 Fortune</a></th>
<th><a href="source/plugins/community/nightscout/README.md">💉 Nightscout</a></th>
<th><a href="/source/plugins/community/fortune/README.md">🥠 Fortune</a></th>
<th><a href="/source/plugins/community/nightscout/README.md">💉 Nightscout</a></th>
</tr>
<tr>
<td align="center">
@@ -15,8 +15,8 @@
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a></th>
<th><a href="source/plugins/community/screenshot/README.md">📸 Website screenshot</a></th>
<th><a href="/source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a></th>
<th><a href="/source/plugins/community/screenshot/README.md">📸 Website screenshot</a></th>
</tr>
<tr>
<td align="center">
@@ -28,7 +28,7 @@
<img width="900" height="1" alt="">
</td>
</tr> <tr>
<th><a href="source/plugins/community/stock/README.md">💹 Stock prices</a></th>
<th><a href="/source/plugins/community/stock/README.md">💹 Stock prices</a></th>
<th></th>
</tr>
<tr>

2
source/plugins/community/nightscout/README.md
View File

@@ -125,7 +125,7 @@ Check out the instructions there.
```yaml
uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
plugin_nightscout: yes
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}

2
source/plugins/community/nightscout/examples.yml
View File

@@ -1,6 +1,6 @@
- uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
plugin_nightscout: yes
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
prod:

3
source/plugins/community/poopmap/README.md
View File

@@ -97,7 +97,8 @@ This token will not expire and it will be able to access only public details.
```yaml
uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}
plugin_poopmap: yes
```

3
source/plugins/community/poopmap/examples.yml
View File

@@ -1,6 +1,7 @@
- uses: lowlighter/metrics@latest
with:
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}
plugin_poopmap: yes
prod:
skip: true

2
source/plugins/community/screenshot/README.md
View File

@@ -91,7 +91,7 @@ name: XKCD of the day
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.screenshot.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_screenshot: yes
plugin_screenshot_title: XKCD of the day

2
source/plugins/community/screenshot/examples.yml
View File

@@ -2,7 +2,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.screenshot.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_screenshot: yes
plugin_screenshot_title: XKCD of the day

4
source/plugins/core/README.md
View File

@@ -382,7 +382,9 @@ On forks, this feature is disable to take into account any changes you made on i
<td nowrap="nowrap"><code>token</code></td>
<td rowspan="2"><p>GitHub Personal Access Token</p>
<p>No scopes are required by default, though some plugins and features may require additional scopes</p>
<p>When using a configuration which does not requires a GitHub PAT, you may pass <code>NOT_NEEDED</code> instead</p>
<p>When using a configuration which does not requires a GitHub PAT, you may pass <code>NOT_NEEDED</code> instead.
Note that when doing so, all defaults values using <code>.user.*</code> will not be applicable meaning that they need to be filled manually.
Most of the time <code>user</code> option must also be set.</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>

4
source/plugins/core/metadata.yml
View File

@@ -14,7 +14,9 @@ inputs:
No scopes are required by default, though some plugins and features may require additional scopes
When using a configuration which does not requires a GitHub PAT, you may pass `NOT_NEEDED` instead
When using a configuration which does not requires a GitHub PAT, you may pass `NOT_NEEDED` instead.
Note that when doing so, all defaults values using `.user.*` will not be applicable meaning that they need to be filled manually.
Most of the time `user` option must also be set.
type: token
required: true

4
source/plugins/posts/README.md
View File

@@ -109,7 +109,7 @@ name: Recent posts
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.posts.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_posts: yes
plugin_posts_source: dev.to
@@ -120,7 +120,7 @@ name: Recent posts with descriptions and cover images
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.posts.full.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_posts: yes
plugin_posts_source: dev.to

4
source/plugins/posts/examples.yml
View File

@@ -2,7 +2,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.posts.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_posts: yes
plugin_posts_source: dev.to
@@ -11,7 +11,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.posts.full.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_posts: yes
plugin_posts_source: dev.to

2
source/plugins/stackoverflow/README.md
View File

@@ -119,7 +119,7 @@ name: Top answers from stackoverflow
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.stackoverflow.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_stackoverflow: yes
plugin_stackoverflow_user: 1

2
source/plugins/stackoverflow/examples.yml
View File

@@ -2,7 +2,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.stackoverflow.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_stackoverflow: yes
plugin_stackoverflow_user: 1

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

@@ -15,8 +15,8 @@
</tr>
<tr>
<td colspan="2" align="center">
<details open><summary>Chartist charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg" alt=""></img></details>
<details><summary>Classic charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg" alt=""></img></details>
<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>
<img width="900" height="1" alt="">
</td>
</tr>
@@ -53,7 +53,7 @@
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
<b>type:</b> <code>string</code>
<br>
<b>default:</b> null<br>
<b>default:</b> classic<br>
<b>allowed values:</b><ul><li>classic</li><li>chartist</li></ul></td>
</tr>
</table>

4
source/plugins/stargazers/metadata.yml
View File

@@ -2,8 +2,8 @@ name: "✨ Stargazers over last weeks"
category: github
description: This plugin displays your stargazers evolution across all of your repositories over the last two weeks.
examples:
+chartist charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg
classic charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg
+classic charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg
chartist charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg
index: 10
supports:
- user

2
source/plugins/starlists/README.md
View File

@@ -109,7 +109,7 @@ name: Featured star list
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.starlists.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_starlists: yes
plugin_starlists_limit_repositories: 2

2
source/plugins/starlists/examples.yml
View File

@@ -2,7 +2,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.starlists.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_starlists: yes
plugin_starlists_limit_repositories: 2

4
source/plugins/topics/README.md
View File

@@ -101,7 +101,7 @@ name: Labels
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.topics.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_topics: yes
plugin_topics_limit: 12
@@ -112,7 +112,7 @@ name: Icons
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.topics.icons.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_topics: yes
plugin_topics_limit: 0

4
source/plugins/topics/examples.yml
View File

@@ -2,7 +2,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.topics.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_topics: yes
plugin_topics_limit: 12
@@ -11,7 +11,7 @@
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.topics.icons.svg
token: ${{ secrets.METRICS_TOKEN }}
token: NOT_NEEDED
base: ""
plugin_topics: yes
plugin_topics_limit: 0