diff --git a/README.md b/README.md index e753d819..85c03b88 100644 --- a/README.md +++ b/README.md @@ -47,30 +47,30 @@ Generate metrics that can be embedded everywhere, including your GitHub profile 🌟 Recently starred repositories - -
With icons
-
With labels
- - - +
With icons + +
+
With labels + +
+ + + + 📜 Repository licenses 💡 Coding habits - -
Permissions, limitations and conditions - -
-
Licenses overview - -
- - + +
Permissions, limitations and conditions
+
Licenses overview
+ +
Recent activity charts diff --git a/settings.example.json b/settings.example.json index 0f7308e4..10840566 100644 --- a/settings.example.json +++ b/settings.example.json @@ -39,13 +39,13 @@ "enabled": false, "//": "Enable languages plugin" }, "topics":{ - "enabled": false, "//": "Enable topics plugin" + "enabled": false, "//": "Display starred topics" }, "stars":{ - "enabled": false, "//": "Display recently starred repositories" + "enabled": false, "//": "Enable stars plugin" }, "licenses":{ - "enabled": false, "//": "Display licenses informations" + "enabled": false, "//": "Enable licenses plugin" }, "habits":{ "enabled": false, "//": "Display coding habits metrics" diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md index 82ebee32..c9f5c33c 100644 --- a/source/plugins/isocalendar/README.md +++ b/source/plugins/isocalendar/README.md @@ -43,6 +43,10 @@ plugin_isocalendar_duration

Time window

+ diff --git a/source/plugins/isocalendar/metadata.yml b/source/plugins/isocalendar/metadata.yml index 3eb3c43a..a82632a8 100644 --- a/source/plugins/isocalendar/metadata.yml +++ b/source/plugins/isocalendar/metadata.yml @@ -17,7 +17,10 @@ inputs: default: no plugin_isocalendar_duration: - description: Time window + description: | + Time window + - `half-year`: 180 days + - `full-year`: 1 year type: string default: half-year values: diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index d5a27169..62cfe18d 100644 --- a/source/plugins/licenses/README.md +++ b/source/plugins/licenses/README.md @@ -1,30 +1,50 @@ -### 📜 Repository licenses + + + + + + + + + + + + + + + + + +

📜 Repository licenses

This plugin display repository license informations like permissions, limitations and conditions along with additional stats about dependencies.

+
Supported features
→ Full specification		📘 Repository template
📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
Permissions, limitations and conditions
+
Licenses overview
+ +
+ + +## 🔎 Licenses analysis + +Use to `plugin_licenses_setup` command to setup project dependencies. + +*Example: setup a NodeJS project using `npm ci`* +```yml +- name: Licenses and permissions + with: + repo: metrics + plugin_licenses: yes + plugin_licenses_setup: npm ci +``` + +Dependencies will be analyzed by [GitHub licensed](https://github.com/github/licensed) and compared against GitHub known licenses. > ⚠ī¸ This is **NOT** legal advice, use at your own risk -> đŸ”Ŗ On web instances, this plugin is an extra feature and must be enabled globally in `settings.json` -> đŸ’Ŗ Note that this plugin allows raw commands injection and is **NOT** advised to be enabled on them +> đŸ’Ŗ This plugin **SHOULD NOT** be enabled on web instances, since it allows raw command injection. > This could result in compromised server! -The *licenses* plugin lets you display license informations like permissions, limitations and conditions along with additional metrics about dependencies. - - -
-
Permissions, limitations and conditions - -
-
Licenses overview - -
- -
- -Project must be setup with dependencies using `plugin_licenses_setup` option (for example, `npm ci` for a NodeJS project). - -Dependencies will be analyzed with [github/licensed](https://github.com/github/licensed) and compared against GitHub known licenses. - -#### ➡ī¸ Available options +## ➡ī¸ Available options @@ -33,7 +53,7 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l - @@ -44,7 +64,7 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l - @@ -63,7 +83,7 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l - @@ -74,9 +94,7 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l
plugin_licenses

Display licenses informations

+

Enable licenses plugin
plugin_licenses_setup

Command to setup target repository

+

Setup command
plugin_licenses_legal

Display legal informations about used licenses

+

Display permissions, limitations and conditions about used licenses
-*[→ Full specification](metadata.yml)* - -#### ℹī¸ Examples workflows +## ℹī¸ Examples workflows ```yaml diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml index 75c0643d..182d5a51 100644 --- a/source/plugins/licenses/metadata.yml +++ b/source/plugins/licenses/metadata.yml @@ -1,5 +1,9 @@ name: "📜 Repository licenses" category: github +description: This plugin display repository license informations like permissions, limitations and conditions along with additional stats about dependencies. +examples: + +permissions, limitations and conditions: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.svg + +licenses overview: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.ratio.svg index: 4 supports: - repository @@ -7,30 +11,24 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_licenses: - description: Display licenses informations + description: Enable licenses plugin type: boolean default: no extras: yes - # Command to use to setup target repository - # It is required to install all dependencies that will be analyzed with github/licensed plugin_licenses_setup: - description: Command to setup target repository + description: Setup command type: string default: "" example: npm ci - # Display used licenses from both repository license and dependencies licenses ratio plugin_licenses_ratio: description: Display used licenses ratio type: boolean default: no - # Display permissions, limitations and conditions from both repository license and dependencies licenses - # Note that this is NOT legal advice, use at your own risk plugin_licenses_legal: - description: Display legal informations about used licenses + description: Display permissions, limitations and conditions about used licenses type: boolean default: yes \ No newline at end of file diff --git a/source/plugins/stars/README.md b/source/plugins/stars/README.md index 3d1cf438..b6a2a234 100644 --- a/source/plugins/stars/README.md +++ b/source/plugins/stars/README.md @@ -1,15 +1,28 @@ -### 🌟 Recently starred repositories - -The *stars* plugin displays your recently starred repositories. - + - + + + + + + + + + + + + + + +
- - -

🌟 Recently starred repositories

This plugin displays your recently starred repositories.

+
Supported features
→ Full specification		📗 Classic template
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+ + +
+ -#### ➡ī¸ Available options +## ➡ī¸ Available options @@ -18,7 +31,7 @@ The *stars* plugin displays your recently starred repositories. - @@ -28,7 +41,7 @@ The *stars* plugin displays your recently starred repositories. - @@ -42,9 +55,7 @@ The *stars* plugin displays your recently starred repositories.
plugin_stars

Display recently starred repositories

+

Enable stars plugin
plugin_stars_limit

Maximum number of stars to display

+

Display limit
-*[→ Full specification](metadata.yml)* - -#### ℹī¸ Examples workflows +## ℹī¸ Examples workflows ```yaml @@ -58,4 +69,4 @@ with: plugin_stars_limit: 3 ``` - \ No newline at end of file + diff --git a/source/plugins/stars/metadata.yml b/source/plugins/stars/metadata.yml index 8b181f6d..e93330a5 100644 --- a/source/plugins/stars/metadata.yml +++ b/source/plugins/stars/metadata.yml @@ -1,5 +1,8 @@ name: "🌟 Recently starred repositories" category: github +description: This plugin displays your recently starred repositories. +examples: + default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stars.svg index: 3 supports: - user @@ -7,15 +10,13 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_stars: - description: Display recently starred repositories + description: Enable stars plugin type: boolean default: no - # Number of stars to display plugin_stars_limit: - description: Maximum number of stars to display + description: Display limit type: number default: 4 min: 1