Skip to content

Commit b1906e3

Browse files
lowlighterlowlighter
committed
docs: update metadata.yml where token isn't needed
1 parent 65aeac2 commit b1906e3

File tree

20 files changed

+43
-37
lines changed

20 files changed

+43
-37
lines changed

‎.github/workflows/examples.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ jobs:
203203
uses: lowlighter/metrics@master
204204
with:
205205
filename: metrics.plugin.topics.svg
206-
token: ${{ secrets.METRICS_TOKEN }}
206+
token: NOT_NEEDED
207207
base: ""
208208
plugin_topics: yes
209209
plugin_topics_limit: 12
@@ -216,7 +216,7 @@ jobs:
216216
uses: lowlighter/metrics@master
217217
with:
218218
filename: metrics.plugin.topics.icons.svg
219-
token: ${{ secrets.METRICS_TOKEN }}
219+
token: NOT_NEEDED
220220
base: ""
221221
plugin_topics: yes
222222
plugin_topics_limit: 0
@@ -673,7 +673,7 @@ jobs:
673673
uses: lowlighter/metrics@master
674674
with:
675675
filename: metrics.plugin.starlists.svg
676-
token: ${{ secrets.METRICS_TOKEN }}
676+
token: NOT_NEEDED
677677
base: ""
678678
plugin_starlists: yes
679679
plugin_starlists_limit_repositories: 2
@@ -834,7 +834,7 @@ jobs:
834834
uses: lowlighter/metrics@master
835835
with:
836836
filename: metrics.plugin.stackoverflow.svg
837-
token: ${{ secrets.METRICS_TOKEN }}
837+
token: NOT_NEEDED
838838
base: ""
839839
plugin_stackoverflow: yes
840840
plugin_stackoverflow_user: 1
@@ -927,7 +927,7 @@ jobs:
927927
uses: lowlighter/metrics@master
928928
with:
929929
filename: metrics.plugin.posts.svg
930-
token: ${{ secrets.METRICS_TOKEN }}
930+
token: NOT_NEEDED
931931
base: ""
932932
plugin_posts: yes
933933
plugin_posts_source: dev.to
@@ -940,7 +940,7 @@ jobs:
940940
uses: lowlighter/metrics@master
941941
with:
942942
filename: metrics.plugin.posts.full.svg
943-
token: ${{ secrets.METRICS_TOKEN }}
943+
token: NOT_NEEDED
944944
base: ""
945945
plugin_posts: yes
946946
plugin_posts_source: dev.to
@@ -997,7 +997,7 @@ jobs:
997997
uses: lowlighter/metrics@master
998998
with:
999999
filename: metrics.plugin.screenshot.svg
1000-
token: ${{ secrets.METRICS_TOKEN }}
1000+
token: NOT_NEEDED
10011001
base: ""
10021002
plugin_screenshot: yes
10031003
plugin_screenshot_title: XKCD of the day

‎source/plugins/community/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<tr><th colspan="2"><h3>🎲 Community plugins</h3></th></tr>
33
<tr><td colspan="2" align="center">Additional plugins maintained by community for even more features!</td></tr>
44
<tr>
5-
<th><a href="source/plugins/community/fortune/README.md">🥠 Fortune</a></th>
6-
<th><a href="source/plugins/community/nightscout/README.md">💉 Nightscout</a></th>
5+
<th><a href="/source/plugins/community/fortune/README.md">🥠 Fortune</a></th>
6+
<th><a href="/source/plugins/community/nightscout/README.md">💉 Nightscout</a></th>
77
</tr>
88
<tr>
99
<td align="center">
@@ -15,8 +15,8 @@
1515
<img width="900" height="1" alt="">
1616
</td>
1717
</tr> <tr>
18-
<th><a href="source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a></th>
19-
<th><a href="source/plugins/community/screenshot/README.md">📸 Website screenshot</a></th>
18+
<th><a href="/source/plugins/community/poopmap/README.md">💩 PoopMap plugin</a></th>
19+
<th><a href="/source/plugins/community/screenshot/README.md">📸 Website screenshot</a></th>
2020
</tr>
2121
<tr>
2222
<td align="center">
@@ -28,7 +28,7 @@
2828
<img width="900" height="1" alt="">
2929
</td>
3030
</tr> <tr>
31-
<th><a href="source/plugins/community/stock/README.md">💹 Stock prices</a></th>
31+
<th><a href="/source/plugins/community/stock/README.md">💹 Stock prices</a></th>
3232
<th></th>
3333
</tr>
3434
<tr>

‎source/plugins/community/nightscout/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Check out the instructions there.
125125
```yaml
126126
uses: lowlighter/metrics@latest
127127
with:
128-
token: ${{ secrets.METRICS_TOKEN }}
128+
token: NOT_NEEDED
129129
plugin_nightscout: yes
130130
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
131131

‎source/plugins/community/nightscout/examples.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
- uses: lowlighter/metrics@latest
22
with:
3-
token: ${{ secrets.METRICS_TOKEN }}
3+
token: NOT_NEEDED
44
plugin_nightscout: yes
55
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
66
prod:

‎source/plugins/community/poopmap/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ This token will not expire and it will be able to access only public details.
9797
```yaml
9898
uses: lowlighter/metrics@latest
9999
with:
100-
token: ${{ secrets.METRICS_TOKEN }}
100+
token: NOT_NEEDED
101+
plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}
101102
plugin_poopmap: yes
102103

103104
```

‎source/plugins/community/poopmap/examples.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
- uses: lowlighter/metrics@latest
22
with:
3-
token: ${{ secrets.METRICS_TOKEN }}
3+
token: NOT_NEEDED
4+
plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}
45
plugin_poopmap: yes
56
prod:
67
skip: true

‎source/plugins/community/screenshot/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ name: XKCD of the day
9191
uses: lowlighter/metrics@latest
9292
with:
9393
filename: metrics.plugin.screenshot.svg
94-
token: ${{ secrets.METRICS_TOKEN }}
94+
token: NOT_NEEDED
9595
base: ""
9696
plugin_screenshot: yes
9797
plugin_screenshot_title: XKCD of the day

‎source/plugins/community/screenshot/examples.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
uses: lowlighter/metrics@latest
33
with:
44
filename: metrics.plugin.screenshot.svg
5-
token: ${{ secrets.METRICS_TOKEN }}
5+
token: NOT_NEEDED
66
base: ""
77
plugin_screenshot: yes
88
plugin_screenshot_title: XKCD of the day

‎source/plugins/core/README.md

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

‎source/plugins/core/metadata.yml

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

‎source/plugins/posts/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ name: Recent posts
109109
uses: lowlighter/metrics@latest
110110
with:
111111
filename: metrics.plugin.posts.svg
112-
token: ${{ secrets.METRICS_TOKEN }}
112+
token: NOT_NEEDED
113113
base: ""
114114
plugin_posts: yes
115115
plugin_posts_source: dev.to
@@ -120,7 +120,7 @@ name: Recent posts with descriptions and cover images
120120
uses: lowlighter/metrics@latest
121121
with:
122122
filename: metrics.plugin.posts.full.svg
123-
token: ${{ secrets.METRICS_TOKEN }}
123+
token: NOT_NEEDED
124124
base: ""
125125
plugin_posts: yes
126126
plugin_posts_source: dev.to

‎source/plugins/posts/examples.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
uses: lowlighter/metrics@latest
33
with:
44
filename: metrics.plugin.posts.svg
5-
token: ${{ secrets.METRICS_TOKEN }}
5+
token: NOT_NEEDED
66
base: ""
77
plugin_posts: yes
88
plugin_posts_source: dev.to
@@ -11,7 +11,7 @@
1111
uses: lowlighter/metrics@latest
1212
with:
1313
filename: metrics.plugin.posts.full.svg
14-
token: ${{ secrets.METRICS_TOKEN }}
14+
token: NOT_NEEDED
1515
base: ""
1616
plugin_posts: yes
1717
plugin_posts_source: dev.to

‎source/plugins/stackoverflow/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ name: Top answers from stackoverflow
119119
uses: lowlighter/metrics@latest
120120
with:
121121
filename: metrics.plugin.stackoverflow.svg
122-
token: ${{ secrets.METRICS_TOKEN }}
122+
token: NOT_NEEDED
123123
base: ""
124124
plugin_stackoverflow: yes
125125
plugin_stackoverflow_user: 1

‎source/plugins/stackoverflow/examples.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
uses: lowlighter/metrics@latest
33
with:
44
filename: metrics.plugin.stackoverflow.svg
5-
token: ${{ secrets.METRICS_TOKEN }}
5+
token: NOT_NEEDED
66
base: ""
77
plugin_stackoverflow: yes
88
plugin_stackoverflow_user: 1

‎source/plugins/stargazers/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
</tr>
1616
<tr>
1717
<td colspan="2" align="center">
18-
<details open><summary>Chartist charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg" alt=""></img></details>
19-
<details><summary>Classic charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg" alt=""></img></details>
18+
<details open><summary>Classic charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg" alt=""></img></details>
19+
<details><summary>Chartist charts</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg" alt=""></img></details>
2020
<img width="900" height="1" alt="">
2121
</td>
2222
</tr>
@@ -53,7 +53,7 @@
5353
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
5454
<b>type:</b> <code>string</code>
5555
<br>
56-
<b>default:</b> null<br>
56+
<b>default:</b> classic<br>
5757
<b>allowed values:</b><ul><li>classic</li><li>chartist</li></ul></td>
5858
</tr>
5959
</table>

‎source/plugins/stargazers/metadata.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name: "✨ Stargazers over last weeks"
22
category: github
33
description: This plugin displays your stargazers evolution across all of your repositories over the last two weeks.
44
examples:
5-
+chartist charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg
6-
classic charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg
5+
+classic charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg
6+
chartist charts: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.chartist.svg
77
index: 10
88
supports:
99
- user

‎source/plugins/starlists/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ name: Featured star list
109109
uses: lowlighter/metrics@latest
110110
with:
111111
filename: metrics.plugin.starlists.svg
112-
token: ${{ secrets.METRICS_TOKEN }}
112+
token: NOT_NEEDED
113113
base: ""
114114
plugin_starlists: yes
115115
plugin_starlists_limit_repositories: 2

‎source/plugins/starlists/examples.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
uses: lowlighter/metrics@latest
33
with:
44
filename: metrics.plugin.starlists.svg
5-
token: ${{ secrets.METRICS_TOKEN }}
5+
token: NOT_NEEDED
66
base: ""
77
plugin_starlists: yes
88
plugin_starlists_limit_repositories: 2

‎source/plugins/topics/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ name: Labels
101101
uses: lowlighter/metrics@latest
102102
with:
103103
filename: metrics.plugin.topics.svg
104-
token: ${{ secrets.METRICS_TOKEN }}
104+
token: NOT_NEEDED
105105
base: ""
106106
plugin_topics: yes
107107
plugin_topics_limit: 12
@@ -112,7 +112,7 @@ name: Icons
112112
uses: lowlighter/metrics@latest
113113
with:
114114
filename: metrics.plugin.topics.icons.svg
115-
token: ${{ secrets.METRICS_TOKEN }}
115+
token: NOT_NEEDED
116116
base: ""
117117
plugin_topics: yes
118118
plugin_topics_limit: 0

‎source/plugins/topics/examples.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
uses: lowlighter/metrics@latest
33
with:
44
filename: metrics.plugin.topics.svg
5-
token: ${{ secrets.METRICS_TOKEN }}
5+
token: NOT_NEEDED
66
base: ""
77
plugin_topics: yes
88
plugin_topics_limit: 12
@@ -11,7 +11,7 @@
1111
uses: lowlighter/metrics@latest
1212
with:
1313
filename: metrics.plugin.topics.icons.svg
14-
token: ${{ secrets.METRICS_TOKEN }}
14+
token: NOT_NEEDED
1515
base: ""
1616
plugin_topics: yes
1717
plugin_topics_limit: 0

0 commit comments

Comments
 (0)