From 8b34b0ab935ff61080ae3196a871bf32dc3a0ae6 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 17 Jan 2023 06:30:11 +0000
Subject: [PATCH] ci: auto-regenerate files
---
.../partials/documentation/compatibility.md | 11 ++-
README.md | 58 +++++++------
action.yml | 15 ++++
settings.example.json | 3 +
source/plugins/README.md | 1 +
source/plugins/sponsorships/README.md | 82 +++++++++++++++++++
source/templates/classic/README.md | 2 +-
tests/cases/sponsorships.plugin.yml | 7 ++
8 files changed, 150 insertions(+), 29 deletions(-)
create mode 100644 tests/cases/sponsorships.plugin.yml
diff --git a/.github/readme/partials/documentation/compatibility.md b/.github/readme/partials/documentation/compatibility.md
index 006779b7..400b3483 100644
--- a/.github/readme/partials/documentation/compatibility.md
+++ b/.github/readme/partials/documentation/compatibility.md
@@ -30,6 +30,7 @@
| ๐ซ |
๐๏ธ |
๐ |
+ ๐ |
๐ญ |
โฑ๏ธ |
๐ค |
@@ -70,6 +71,7 @@
โ๏ธ |
โ๏ธ |
โ๏ธ |
+ โ๏ธ |
โ๏ธ |
โ๏ธ |
โ๏ธ |
@@ -110,6 +112,7 @@
โ |
โ๏ธ |
โ |
+ โ |
โ |
โ๏ธ |
โ |
@@ -150,6 +153,7 @@
โ๏ธ |
โ |
โ |
+ โ |
โ |
โ๏ธ |
โ |
@@ -190,6 +194,7 @@
โ |
โ |
โ |
+ โ |
โ |
โ |
โ๏ธ |
@@ -202,7 +207,7 @@
โ |
- |
+ |
| Mode/Plugin |
@@ -233,6 +238,7 @@
๐ซ |
๐๏ธ |
๐ |
+ ๐ |
๐ญ |
โฑ๏ธ |
๐ค |
@@ -273,6 +279,7 @@
โ๏ธ |
โ๏ธ |
โ๏ธ |
+ โ๏ธ |
โ๏ธ |
โ๏ธ |
โ๏ธ |
@@ -313,6 +320,7 @@
โ |
โ๏ธ |
โ |
+ โ๏ธ |
โ |
โ๏ธ |
โ๏ธ |
@@ -353,6 +361,7 @@
โ |
โ๏ธ |
โ |
+ โ |
โ |
โ๏ธ |
โ |
diff --git a/README.md b/README.md
index fd506609..4ddae298 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
|
-
+
|
@@ -227,78 +227,81 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
+ | ๐ GitHub Sponsorships |
โฑ๏ธ Google PageSpeed |
- ๐ค Latest tweets |
+
+ 
+ ![]()
+ |
PageSpeed scores PageSpeed scores with detailed report PageSpeed scores with a website screenshot ![]()
|
+
+
+ | ๐ค Latest tweets |
+ ๐จ๏ธ Stack Overflow |
+
+
Latest tweets with attachments Latest tweets ![]()
|
-
-
- | ๐จ๏ธ Stack Overflow |
- ๐ธ Anilist watch list and reading list |
-
-
![]()
|
+
+
+ | ๐ธ Anilist watch list and reading list |
+ ๐ผ Music activity and suggestions |
+
+
For anime watchers For manga readers For waifus simp ![]()
|
-
-
- | ๐ผ Music activity and suggestions |
- โ๏ธ Recent posts |
-
-
Random tracks from a playlist Recently listened ![]()
|
+
+
+ | โ๏ธ Recent posts |
+ ๐ผ Rss feed |
+
+
Latest posts width description and cover image Latest posts ![]()
|
-
-
- | ๐ผ Rss feed |
- โฐ WakaTime |
-
-
![]()
|
+
+
+ | โฐ WakaTime |
+ ๐ณ๏ธ Leetcode |
+
+
![]()
|
-
-
- | ๐ณ๏ธ Leetcode |
- |
-
-
![]()
|
- ![]() |
@@ -497,6 +500,7 @@ Plugins provide additional content and lets you customize rendered metrics.
* [๐ Featured repositories `repositories`](/source/plugins/repositories/README.md)
* [๐ GitHub Skyline `skyline`](/source/plugins/skyline/README.md)
* [๐ GitHub Sponsors `sponsors`](/source/plugins/sponsors/README.md)
+ * [๐ GitHub Sponsorships `sponsorships`](/source/plugins/sponsorships/README.md)
* [โจ Stargazers `stargazers`](/source/plugins/stargazers/README.md)
* [๐ซ Star lists `starlists`](/source/plugins/starlists/README.md)
* [๐ Recently starred repositories `stars`](/source/plugins/stars/README.md)
diff --git a/action.yml b/action.yml
index a1dd590b..52229a17 100644
--- a/action.yml
+++ b/action.yml
@@ -949,6 +949,21 @@ inputs:
description: Advanced settings
default:
+ # ====================================================================================
+ # ๐ GitHub Sponsorships
+
+ plugin_sponsorships:
+ description: Enable sponsorships plugin
+ default:
+
+ plugin_sponsorships_sections:
+ description: Displayed sections
+ default:
+
+ plugin_sponsorships_size:
+ description: Profile picture display size
+ default:
+
# ====================================================================================
# ๐ญ GitHub Community Support
diff --git a/settings.example.json b/settings.example.json
index c76ec09f..ec11abd1 100644
--- a/settings.example.json
+++ b/settings.example.json
@@ -143,6 +143,9 @@
"skyline":{
"enabled": false, "//": "Enable skyline plugin"
},
+ "sponsorships":{
+ "enabled": false, "//": "Enable sponsorships plugin"
+ },
"support":{
"enabled": false, "//": "Enable support plugin"
},
diff --git a/source/plugins/README.md b/source/plugins/README.md
index b28547e2..e34fa9b4 100644
--- a/source/plugins/README.md
+++ b/source/plugins/README.md
@@ -29,6 +29,7 @@ Plugins provide additional content and lets you customize rendered metrics.
* [๐ Featured repositories `repositories`](/source/plugins/repositories/README.md)
* [๐ GitHub Skyline `skyline`](/source/plugins/skyline/README.md)
* [๐ GitHub Sponsors `sponsors`](/source/plugins/sponsors/README.md)
+ * [๐ GitHub Sponsorships `sponsorships`](/source/plugins/sponsorships/README.md)
* [โจ Stargazers `stargazers`](/source/plugins/stargazers/README.md)
* [๐ซ Star lists `starlists`](/source/plugins/starlists/README.md)
* [๐ Recently starred repositories `stars`](/source/plugins/stars/README.md)
diff --git a/source/plugins/sponsorships/README.md b/source/plugins/sponsorships/README.md
index 3eff2a87..5194d117 100644
--- a/source/plugins/sponsorships/README.md
+++ b/source/plugins/sponsorships/README.md
@@ -1,12 +1,94 @@
+
+ | โ Back to plugins index |
+ ๐ GitHub Sponsorships |
|---|
+ This plugin displays sponsorships funded through GitHub sponsors.
+ |
+ | โ ๏ธ Disclaimer | This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub.
+All product and company names are trademarksโข or registeredยฎ trademarks of their respective holders.
+ |
|---|
+
+ Supported features
โ Full specification |
+ ๐ Classic template |
+
+
+ ๐ค Users ๐ฅ Organizations |
+
+
+ ๐ read:user ๐ read:org read:packages (optional) repo (optional) |
+
+
+
+
+ ![]()
+ |
+
+
## โก๏ธ Available options
+
+
+ | Option | Description |
+
+
+ plugin_sponsorships
|
+ Enable sponsorships plugin
+![]() |
+
+
+ โจ On master/main
+type: boolean
+
+default: no
|
+
+
+ plugin_sponsorships_sections
|
+ Displayed sections
+
+amount: display total amount sponsoredsponsorships: display GitHub sponsorships
+![]() |
+
+
+ โจ On master/main
+type: array
+(comma-separated)
+
+default: amount, sponsorships
+allowed values: |
+
+
+ plugin_sponsorships_size
|
+ Profile picture display size
+![]() |
+
+
+ โจ On master/main
+type: number
+(8 โค
+๐ฅ
+โค 64)
+
+default: 24
|
+
+
## โน๏ธ Examples workflows
+```yaml
+name: ๐ GitHub sponsorships
+uses: lowlighter/metrics@latest
+with:
+ filename: metrics.plugin.sponsorships.svg
+ token: ${{ secrets.METRICS_TOKEN }}
+ base: ""
+ plugin_sponsorships: yes
+
+```
diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md
index 1b07964c..23509ab1 100644
--- a/source/templates/classic/README.md
+++ b/source/templates/classic/README.md
@@ -7,7 +7,7 @@ This is also the default template.
|
Supported features
โ Full specification |
- ๐ ๐ฐ ๐ธ ๐ โ โ๏ธ ๐ฅ ๐ ๐ฉ ๐ธ ๐ฆ ๐น ๐ฌ ๐๏ธ ๐ซ ๐ก ๐ ๐
๐ท๏ธ ๐ณ๏ธ ๐จโ๐ป ๐ผ ๐ฉ โฑ๏ธ ๐งโ๐คโ๐ง โ๏ธ ๐๏ธ ๐ญ ๐ ๐ผ ๐ ๐ ๐จ๏ธ โจ ๐ซ ๐ ๐ญ ๐ ๐งฎ ๐ค โฐ |
+ ๐ ๐ฐ ๐ธ ๐ โ โ๏ธ ๐ฅ ๐ ๐ฉ ๐ธ ๐ฆ ๐น ๐ฌ ๐๏ธ ๐ซ ๐ก ๐ ๐
๐ท๏ธ ๐ณ๏ธ ๐จโ๐ป ๐ผ ๐ฉ โฑ๏ธ ๐งโ๐คโ๐ง โ๏ธ ๐๏ธ ๐ญ ๐ ๐ผ ๐ ๐ ๐ ๐จ๏ธ โจ ๐ซ ๐ ๐ญ ๐ ๐งฎ ๐ค โฐ |
๐ค Users ๐ฅ Organizations |
diff --git a/tests/cases/sponsorships.plugin.yml b/tests/cases/sponsorships.plugin.yml
new file mode 100644
index 00000000..5dc5ff73
--- /dev/null
+++ b/tests/cases/sponsorships.plugin.yml
@@ -0,0 +1,7 @@
+- name: ๐ GitHub Sponsorships - ๐ GitHub sponsorships
+ uses: lowlighter/metrics@latest
+ with:
+ token: MOCKED_TOKEN
+ plugin_sponsorships: 'yes'
+ use_mocked_data: 'yes'
+ verify: 'yes'