From b1906e3de81fa7df7df809695b93e0fa41eb41af Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Thu, 27 Jan 2022 20:09:26 -0500 Subject: [PATCH] docs: update metadata.yml where token isn't needed --- .github/workflows/examples.yml | 14 +++++++------- source/plugins/community/README.md | 10 +++++----- source/plugins/community/nightscout/README.md | 2 +- source/plugins/community/nightscout/examples.yml | 2 +- source/plugins/community/poopmap/README.md | 3 ++- source/plugins/community/poopmap/examples.yml | 3 ++- source/plugins/community/screenshot/README.md | 2 +- source/plugins/community/screenshot/examples.yml | 2 +- source/plugins/core/README.md | 4 +++- source/plugins/core/metadata.yml | 4 +++- source/plugins/posts/README.md | 4 ++-- source/plugins/posts/examples.yml | 4 ++-- source/plugins/stackoverflow/README.md | 2 +- source/plugins/stackoverflow/examples.yml | 2 +- source/plugins/stargazers/README.md | 6 +++--- source/plugins/stargazers/metadata.yml | 4 ++-- source/plugins/starlists/README.md | 2 +- source/plugins/starlists/examples.yml | 2 +- source/plugins/topics/README.md | 4 ++-- source/plugins/topics/examples.yml | 4 ++-- 20 files changed, 43 insertions(+), 37 deletions(-) diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 34786238..3037d6d6 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -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 diff --git a/source/plugins/community/README.md b/source/plugins/community/README.md index 9ab1e8b2..4b1c0401 100644 --- a/source/plugins/community/README.md +++ b/source/plugins/community/README.md @@ -2,8 +2,8 @@

🎲 Community plugins

Additional plugins maintained by community for even more features! - 🥠 Fortune - 💉 Nightscout + 🥠 Fortune + 💉 Nightscout @@ -15,8 +15,8 @@ - 💩 PoopMap plugin - 📸 Website screenshot + 💩 PoopMap plugin + 📸 Website screenshot @@ -28,7 +28,7 @@ - 💹 Stock prices + 💹 Stock prices diff --git a/source/plugins/community/nightscout/README.md b/source/plugins/community/nightscout/README.md index ddca1aba..53303f8e 100644 --- a/source/plugins/community/nightscout/README.md +++ b/source/plugins/community/nightscout/README.md @@ -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 }} diff --git a/source/plugins/community/nightscout/examples.yml b/source/plugins/community/nightscout/examples.yml index f6fd61e7..aaedd354 100644 --- a/source/plugins/community/nightscout/examples.yml +++ b/source/plugins/community/nightscout/examples.yml @@ -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: diff --git a/source/plugins/community/poopmap/README.md b/source/plugins/community/poopmap/README.md index 9cdebd56..77df53ff 100644 --- a/source/plugins/community/poopmap/README.md +++ b/source/plugins/community/poopmap/README.md @@ -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 ``` diff --git a/source/plugins/community/poopmap/examples.yml b/source/plugins/community/poopmap/examples.yml index 2821c088..ef7c6988 100644 --- a/source/plugins/community/poopmap/examples.yml +++ b/source/plugins/community/poopmap/examples.yml @@ -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 \ No newline at end of file diff --git a/source/plugins/community/screenshot/README.md b/source/plugins/community/screenshot/README.md index cda82999..0b6a3605 100644 --- a/source/plugins/community/screenshot/README.md +++ b/source/plugins/community/screenshot/README.md @@ -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 diff --git a/source/plugins/community/screenshot/examples.yml b/source/plugins/community/screenshot/examples.yml index 6b146aa0..202608e2 100644 --- a/source/plugins/community/screenshot/examples.yml +++ b/source/plugins/community/screenshot/examples.yml @@ -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 diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md index a8e72148..48bbf179 100644 --- a/source/plugins/core/README.md +++ b/source/plugins/core/README.md @@ -382,7 +382,9 @@ On forks, this feature is disable to take into account any changes you made on i token

GitHub Personal Access Token

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.

diff --git a/source/plugins/core/metadata.yml b/source/plugins/core/metadata.yml index 0d3f91c2..d998f596 100644 --- a/source/plugins/core/metadata.yml +++ b/source/plugins/core/metadata.yml @@ -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 diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md index 71f4831e..8e590c37 100644 --- a/source/plugins/posts/README.md +++ b/source/plugins/posts/README.md @@ -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 diff --git a/source/plugins/posts/examples.yml b/source/plugins/posts/examples.yml index f952b4f8..dc53c9ba 100644 --- a/source/plugins/posts/examples.yml +++ b/source/plugins/posts/examples.yml @@ -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 diff --git a/source/plugins/stackoverflow/README.md b/source/plugins/stackoverflow/README.md index edca9540..d7195aa3 100644 --- a/source/plugins/stackoverflow/README.md +++ b/source/plugins/stackoverflow/README.md @@ -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 diff --git a/source/plugins/stackoverflow/examples.yml b/source/plugins/stackoverflow/examples.yml index 4203287e..5946ab16 100644 --- a/source/plugins/stackoverflow/examples.yml +++ b/source/plugins/stackoverflow/examples.yml @@ -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 diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md index 17b005a0..cde173fa 100644 --- a/source/plugins/stargazers/README.md +++ b/source/plugins/stargazers/README.md @@ -15,8 +15,8 @@ -
Chartist charts
-
Classic charts
+
Classic charts
+
Chartist charts
@@ -53,7 +53,7 @@ ✨ On master/main
type: string
-default: null
+default: classic
allowed values: diff --git a/source/plugins/stargazers/metadata.yml b/source/plugins/stargazers/metadata.yml index 67aae895..12d261f9 100644 --- a/source/plugins/stargazers/metadata.yml +++ b/source/plugins/stargazers/metadata.yml @@ -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 diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md index 0f4b7870..e017adc7 100644 --- a/source/plugins/starlists/README.md +++ b/source/plugins/starlists/README.md @@ -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 diff --git a/source/plugins/starlists/examples.yml b/source/plugins/starlists/examples.yml index 088d2c8a..331d5559 100644 --- a/source/plugins/starlists/examples.yml +++ b/source/plugins/starlists/examples.yml @@ -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 diff --git a/source/plugins/topics/README.md b/source/plugins/topics/README.md index eafbaaa4..3e12d791 100644 --- a/source/plugins/topics/README.md +++ b/source/plugins/topics/README.md @@ -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 diff --git a/source/plugins/topics/examples.yml b/source/plugins/topics/examples.yml index 309c2840..9b663a1e 100644 --- a/source/plugins/topics/examples.yml +++ b/source/plugins/topics/examples.yml @@ -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