diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index 592f78df..cfa64d74 100644 --- a/source/plugins/achievements/README.md +++ b/source/plugins/achievements/README.md @@ -41,9 +41,6 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, | `plugin_achievements_only` | `array` *(comma-separated)* **[]** | Unlocked achievements to display | -Legend for option icons: -* πŸ” Value should be stored in repository secrets -* ✨ New feature currently in testing on `master`/`main` *[β†’ Full specification](metadata.yml)* diff --git a/source/plugins/activity/README.md b/source/plugins/activity/README.md index af1eefea..1ba0747a 100644 --- a/source/plugins/activity/README.md +++ b/source/plugins/activity/README.md @@ -41,13 +41,12 @@ Use a full `repo` scope token to display **private** events. | `plugin_activity_filter` | `array` *(comma-separated)* **[all]** *{"all", "comment", "ref/create", "ref/delete", "release", "push", "issue", "pr", "review", "wiki", "fork", "star", "member", "public"}* | Events types to keep | | `plugin_activity_visibility` | `string` **[all]** *{"public", "all"}* | Set events visibility | | `plugin_activity_timestamps` | `boolean` **[no]** | Display events timestamps | -| `plugin_activity_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip | -| `plugin_activity_ignored` | `undefined` **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Actors to ignore | +| `plugin_activity_skipped` ⏩ | `array` *(comma-separated)* **[]** | Repositories to skip | +| `plugin_activity_ignored` ⏩ | `undefined` **[]** | Actors to ignore | Legend for option icons: -* πŸ” Value should be stored in repository secrets -* ✨ New feature currently in testing on `master`/`main` +* ⏩ Value inherits from its related global-level option *[β†’ Full specification](metadata.yml)* diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index 1690a2a6..6e3d6bfc 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -36,12 +36,9 @@ These sections can also be filtered by media type, which can be either `anime`, | `plugin_anilist_limit` | `number` **[2]** *{0 ≀ π‘₯}* | Maximum number of entries to display per section | | `plugin_anilist_limit_characters` | `number` **[22]** *{0 ≀ π‘₯}* | Maximum number of entries to display in characters section | | `plugin_anilist_shuffle` | `boolean` **[yes]** | Shuffle AniList data | -| `plugin_anilist_user` | `string` **[.user.login]** | AniList login | +| `plugin_anilist_user` | `string` **[*β†’ User login*]** | AniList login | -Legend for option icons: -* πŸ” Value should be stored in repository secrets -* ✨ New feature currently in testing on `master`/`main` *[β†’ Full specification](metadata.yml)* diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index 11eb635e..ab6ec7d5 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -34,13 +34,14 @@ These are all enabled by default, but you can explicitely opt out from them. | `repositories_batch` | `number` **[100]** *{1 ≀ π‘₯ ≀ 100}* | Number of repositories to load at once by queries | | `repositories_forks` | `boolean` **[no]** | Include forks in metrics | | `repositories_affiliations` | `array` *(comma-separated)* **[owner]** *{"owner", "collaborator", "organization_member"}* | Repositories affiliations | -| `repositories_skipped` | `array` *(comma-separated)* **[]** | Default repositories to skip | -| `commits_authoring` | `array` *(comma-seperated)* **[.user.login]** | List of surnames or email addresses you use when authoring commits | +| `repositories_skipped` ⏭️ | `array` *(comma-separated)* **[]** | Default repositories to skip | +| `users_ignored` ⏭️ ✨ | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Default users to ignore | +| `commits_authoring` ⏭️ | `array` *(comma-seperated)* **[*β†’ User login*]** | List of surnames or email addresses you use when authoring commits | Legend for option icons: -* πŸ” Value should be stored in repository secrets -* ✨ New feature currently in testing on `master`/`main` +* ⏭️ Value be inherited by its related plugin-level option +* ✨ Currently in beta-testing on `master`/`main` *[β†’ Full specification](metadata.yml)* diff --git a/source/plugins/code/README.md b/source/plugins/code/README.md index 9ba11d34..eca15b33 100644 --- a/source/plugins/code/README.md +++ b/source/plugins/code/README.md @@ -20,13 +20,12 @@ Display a random code snippet from your recent activity history. | `plugin_code_lines` | `number` **[12]** | Maximum number of line that a code snippet can contain | | `plugin_code_load` | `number` **[100]** *{100 ≀ π‘₯ ≀ 1000}* | Number of events to load | | `plugin_code_visibility` | `string` **[public]** *{"public", "all"}* | Set events visibility | -| `plugin_code_skipped` | `array` *(comma-separated)* **[]** | Repositories to skip | +| `plugin_code_skipped` ⏩ | `array` *(comma-separated)* **[]** | Repositories to skip | | `plugin_code_languages` | `array` *(comma-separated)* **[]** | Restrict code snippet languages | Legend for option icons: -* πŸ” Value should be stored in repository secrets -* ✨ New feature currently in testing on `master`/`main` +* ⏩ Value inherits from its related global-level option *[β†’ Full specification](metadata.yml)* diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 285429ce..0cb978ce 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -42,10 +42,10 @@ Matching is performed in keys order. | `plugin_contributors` | `boolean` **[no]** | Display repository contributors | | `plugin_contributors_base` | `string` **[]** | Base reference | | `plugin_contributors_head` | `string` **[master]** | Head reference | -| `plugin_contributors_ignored` | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore | +| `plugin_contributors_ignored` ⏩ | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore | | `plugin_contributors_contributions` | `boolean` **[no]** | Display contributions | | `plugin_contributors_sections` | `array` *(comma-separated)* **[contributors]** *{"contributors", "categories"}* | Sections to display | -| `plugin_contributors_categories` | `json` **[{ +| `plugin_contributors_categories` 🧰 | `json` **[{ "πŸ“š Documentation": ["README.md", "docs/**"], "πŸ’» Code": ["source/**", "src/**"], "#️⃣ Others": ["*"] @@ -54,8 +54,8 @@ Matching is performed in keys order. Legend for option icons: -* πŸ” Value should be stored in repository secrets -* ✨ New feature currently in testing on `master`/`main` +* ⏩ Value inherits from its related global-level option +* 🧰 Must be enabled in `settings.json` (for web instances) *[β†’ Full specification](metadata.yml)* diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md index 2867fdd6..090aa78f 100644 --- a/source/plugins/core/README.md +++ b/source/plugins/core/README.md @@ -7,10 +7,10 @@ Metrics also have general options that impact global metrics rendering. | Option | Type *(format)* **[default]** *{allowed values}* | Description | | ------ | -------------------------------- | ----------- | -| `token` πŸ” | `token` | GitHub Personal Token | +| `token` βœ”οΈ πŸ” | `token` | GitHub Personal Token | | `user` | `string` **[]** | GitHub username | | `repo` | `string` **[]** | GitHub repository | -| `committer_token` πŸ” | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics | +| `committer_token` πŸ” | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics | | `committer_branch` | `string` **[]** | Branch used to commit rendered metrics | | `committer_message` | `string` **[Update ${filename} - [Skip GitHub Action]]** | Commit message | | `committer_gist` | `string` **[]** | Gist used to store metrics | @@ -20,37 +20,40 @@ Metrics also have general options that impact global metrics rendering. | `output_action` | `string` **[commit]** *{"none", "commit", "pull-request", "pull-request-merge", "pull-request-squash", "pull-request-rebase", "gist"}* | Output action | | `output_condition` | `string` **[always]** *{"always", "data-changed"}* | Output condition | | `optimize` | `array` *(comma-separated)* **[css, xml]** *{"css", "xml", "svg"}* | SVG optimization | -| `setup_community_templates` | `array` *(comma-separated,/(?[-a-z0-9]+)[/](?[-a-z0-9]+)@(?[-a-z0-9]+):(?