diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 0e49547b..9d917530 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -420,7 +420,7 @@ jobs: user: lowlighter plugins_errors_fatal: yes if: ${{ success() || failure() }} - - name: ✨ Stargazers over last weeks - Last weeks stargazers + - name: ✨ Stargazers over last weeks - Using classic charts uses: lowlighter/metrics@master with: filename: metrics.plugin.stargazers.svg @@ -432,6 +432,19 @@ jobs: user: lowlighter plugins_errors_fatal: yes if: ${{ success() || failure() }} + - name: ✨ Stargazers over last weeks - Using chartist charts + uses: lowlighter/metrics@master + with: + filename: metrics.plugin.stargazers.chartist.svg + token: ${{ secrets.METRICS_TOKEN }} + base: "" + plugin_stargazers: yes + plugin_stargazers_charts_type: chartist + output_action: none + delay: 120 + user: lowlighter + plugins_errors_fatal: yes + if: ${{ success() || failure() }} - name: 🗂ī¸ Active projects - Project from a repository uses: lowlighter/metrics@master with: diff --git a/README.md b/README.md index a2314068..a59c1c6a 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -

🧩 Customizable with 38 plugins and 237 options!

+

🧩 Customizable with 39 plugins and 239 options!

@@ -109,7 +109,8 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - +
Chartist charts
+
Classic charts
@@ -438,6 +439,7 @@ Plugins provide additional content and lets you customize rendered metrics. * [⏰ WakaTime plugin `wakatime`](/source/plugins/wakatime/README.md) **🎲 Maintained by community** +* [đŸĨ  Fortune `fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter) * [💉 Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [💩 PoopMap plugin `poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) * [📸 Website screenshot `screenshot`](/source/plugins/community/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter) diff --git a/action.yml b/action.yml index 3258bd25..656a494a 100644 --- a/action.yml +++ b/action.yml @@ -488,6 +488,10 @@ inputs: description: Enable stargazers plugin default: no + plugin_stargazers_charts_type: + description: Charts display type + default: null + # ==================================================================================== # 🗂ī¸ Active projects @@ -985,6 +989,13 @@ inputs: description: WakaTime username default: current + # ==================================================================================== + # đŸĨ  Fortune + + plugin_fortune: + description: Enable fortune plugin + default: no + # ==================================================================================== # 💉 Nightscout diff --git a/settings.example.json b/settings.example.json index f01e0642..dc719729 100644 --- a/settings.example.json +++ b/settings.example.json @@ -140,6 +140,9 @@ "token": null, "//":"WakaTime API token", "enabled": false, "//": "Enable wakatime plugin" }, + "fortune":{ + "enabled": false, "//": "Enable fortune plugin" + }, "nightscout":{ "enabled": false, "//": "Enable nightscout plugin" }, diff --git a/source/plugins/README.md b/source/plugins/README.md index 3c6e3c74..41920302 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -45,6 +45,7 @@ Plugins provide additional content and lets you customize rendered metrics. * [⏰ WakaTime plugin `wakatime`](/source/plugins/wakatime/README.md) **🎲 Maintained by community** +* [đŸĨ  Fortune `fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter) * [💉 Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [💩 PoopMap plugin `poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) * [📸 Website screenshot `screenshot`](/source/plugins/community/screenshot/README.md) by [@lowlighter](https://github.com/lowlighter) diff --git a/source/plugins/community/README.md b/source/plugins/community/README.md index a454cf7f..9ab1e8b2 100644 --- a/source/plugins/community/README.md +++ b/source/plugins/community/README.md @@ -2,31 +2,41 @@

🎲 Community plugins

Additional plugins maintained by community for even more features! + đŸĨ  Fortune 💉 Nightscout - 💩 PoopMap plugin + + + + + + 💩 PoopMap plugin + 📸 Website screenshot + + - - 📸 Website screenshot - 💹 Stock prices - - + + 💹 Stock prices + + + + diff --git a/source/plugins/community/fortune/README.md b/source/plugins/community/fortune/README.md index 3eff2a87..5feee005 100644 --- a/source/plugins/community/fortune/README.md +++ b/source/plugins/community/fortune/README.md @@ -1,12 +1,60 @@ + + + + + + + + + + + + + + + + + +

đŸĨ  Fortune

This plugins displays a random fortune message

+
Authors@lowlighter
Supported features
→ Full specification		📗 Classic template
👤 Users
No tokens are required for this plugin
+ + +
## ➡ī¸ Available options + + + + + + + + + + + +
TypeDescription
plugin_fortune

Enable fortune plugin

+
✨ On master/main
+type: boolean +
+default: no
## ℹī¸ Examples workflows +```yaml +name: Fortune +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.fortune.svg + token: NOT_NEEDED + base: "" + plugin_fortune: yes + +``` diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md index effeaca4..17b005a0 100644 --- a/source/plugins/stargazers/README.md +++ b/source/plugins/stargazers/README.md @@ -15,7 +15,8 @@ - +
Chartist charts
+
Classic charts
@@ -39,6 +40,22 @@
default: no
+ + plugin_stargazers_charts_type +

Charts display type

+ + + + + ✨ On master/main
+type: string +
+default: null
+allowed values: + @@ -46,7 +63,7 @@ ```yaml -name: Last weeks stargazers +name: Using classic charts uses: lowlighter/metrics@latest with: filename: metrics.plugin.stargazers.svg @@ -54,5 +71,16 @@ with: base: "" plugin_stargazers: yes +``` +```yaml +name: Using chartist charts +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.stargazers.chartist.svg + token: ${{ secrets.METRICS_TOKEN }} + base: "" + plugin_stargazers: yes + plugin_stargazers_charts_type: chartist + ``` diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md index 69e7db7d..adaa2bd4 100644 --- a/source/templates/classic/README.md +++ b/source/templates/classic/README.md @@ -6,7 +6,7 @@ This is also the default template.

Supported features
→ Full specification - 🏆 📰 🌸 ♐ 💉 💩 📸 💹 đŸ’Ŧ 🎟ī¸ đŸŽĢ 💡 🙋 📅 🈷ī¸ 👨‍đŸ’ģ đŸŽŧ 🎩 ⏱ī¸ 🧑‍🤝‍🧑 ✒ī¸ 🗂ī¸ 🎭 📓 đŸ—ŧ 🌇 💕 🗨ī¸ ✨ đŸ’Ģ 🌟 💭 📌 🧮 🐤 ⏰ + 🏆 📰 🌸 ♐ đŸĨ  💉 💩 📸 💹 đŸ’Ŧ 🎟ī¸ đŸŽĢ 💡 🙋 📅 🈷ī¸ 👨‍đŸ’ģ đŸŽŧ 🎩 ⏱ī¸ 🧑‍🤝‍🧑 ✒ī¸ 🗂ī¸ 🎭 📓 đŸ—ŧ 🌇 💕 🗨ī¸ ✨ đŸ’Ģ 🌟 💭 📌 🧮 🐤 ⏰ 👤 Users đŸ‘Ĩ Organizations diff --git a/tests/cases/fortune.plugin.yml b/tests/cases/fortune.plugin.yml new file mode 100644 index 00000000..b2548371 --- /dev/null +++ b/tests/cases/fortune.plugin.yml @@ -0,0 +1,7 @@ +- name: đŸĨ  Fortune - Fortune + uses: lowlighter/metrics@latest + with: + token: NOT_NEEDED + plugin_fortune: 'yes' + use_mocked_data: 'yes' + verify: 'yes' diff --git a/tests/cases/stargazers.plugin.yml b/tests/cases/stargazers.plugin.yml index b5ef64f0..507fd3cf 100644 --- a/tests/cases/stargazers.plugin.yml +++ b/tests/cases/stargazers.plugin.yml @@ -1,7 +1,15 @@ -- name: ✨ Stargazers over last weeks - Last weeks stargazers +- name: ✨ Stargazers over last weeks - Using classic charts uses: lowlighter/metrics@latest with: token: MOCKED_TOKEN plugin_stargazers: 'yes' use_mocked_data: 'yes' verify: 'yes' +- name: ✨ Stargazers over last weeks - Using chartist charts + uses: lowlighter/metrics@latest + with: + token: MOCKED_TOKEN + plugin_stargazers: 'yes' + plugin_stargazers_charts_type: chartist + use_mocked_data: 'yes' + verify: 'yes'