diff --git a/README.md b/README.md index 165f8095..b6f87cd1 100644 --- a/README.md +++ b/README.md @@ -80,27 +80,17 @@ Generate metrics that can be embedded everywhere, including your GitHub profile 🎟️ Follow-up of issues and pull requests - -
By contribution types - -
-
By number of contributions - -
- - - -
Indepth analysis - -
-
Created on an user's repositories - -
-
Created by an user - -
- - + +
By contribution types
+
By number of contributions
+ + + +
Indepth analysis
+
Created on an user's repositories
+
Created by an user
+ + 🎭 Comment reactions @@ -159,15 +149,11 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
Detailed display
- -
Indepth analysis - -
-
Contributions in organizations only - -
- - + +
Indepth analysis
+
Contributions in organizations only
+ + 💬 Discussions diff --git a/action.yml b/action.yml index 2006a499..38a9983a 100644 --- a/action.yml +++ b/action.yml @@ -470,44 +470,39 @@ inputs: # ==================================================================================== # 🏅 Repository contributors - # Enable or disable plugin + plugin_contributors: - description: Display repository contributors + description: Enable contributors plugin default: no - # Base reference (commit, tag, branch, etc.) + plugin_contributors_base: - description: Base reference + description: Base reference (commit, tag, branch, etc.) default: "" - # Head reference (commit, tag, branch, etc.) + plugin_contributors_head: - description: Head reference + description: Head reference (commit, tag, branch, etc.) default: master - # Ignored contributors (useful to ignore bots users) - plugin_contributors_ignored: - description: Contributors to ignore - default: github-actions[bot], dependabot[bot], dependabot-preview[bot] - # Display total contributions for each contributor + plugin_contributors_ignored: + description: Ignored users + default: "" + + plugin_contributors_contributions: - description: Display contributions + description: Toggle number of contributions display default: no - # Sections to display + plugin_contributors_sections: - description: Sections to display + description: Displayed sections default: contributors - # Contributions categories - # This requires "plugin_contributors_sections" to have "categories" in it to be effective - # - # Pass a JSON object which contains a mapping of category with fileglobs. - # Contributors will be sorted into each category to reflect their contributions. - # Note that order a file will only match the first category matching + plugin_contributors_categories: - description: Contributions categories + description: Configure contribution categories default: | { "📚 Documentation": ["README.md", "docs/**"], @@ -518,19 +513,19 @@ inputs: # ==================================================================================== # 🎟️ Follow-up of issues and pull requests - # Enable or disable plugin + plugin_followup: - description: Display follow-up of repositories issues and pull requests + description: Enable followup plugin default: no - # Sections to display + plugin_followup_sections: - description: Sections to display + description: Displayed sections default: repositories - # Compute issues and pull requests per repositories with special highlighting for maintainers and specified users + plugin_followup_indepth: - description: Indepth follow-up processing + description: Indepth analysis default: no # ==================================================================================== @@ -781,32 +776,29 @@ inputs: # ==================================================================================== # 🎩 Notable contributions - # Enable or disable plugin + plugin_notable: - description: Display notable contributions in organizations + description: Enable notable plugin default: no - # Query filter - # Based on GitHub search notation - # Supported fields are "stars", "forks" and "watchers" + plugin_notable_filter: description: Query filter default: "" - # Filter repositories depending on which type of account it is hosted + plugin_notable_from: - description: Filter by repository host account type + description: Filter by repository owner account type default: organization - # Also display repository name along with organization name - # Note that repositories hosted by user account will always be displayed fully + plugin_notable_repositories: - description: Also display repository name + description: Toggle repository name display default: no - # Compute notable contributions with measured impact + plugin_notable_indepth: - description: Indepth notable contributions processing + description: Indepth mode default: no # ==================================================================================== diff --git a/settings.example.json b/settings.example.json index bea79fa0..a4f6a6a4 100644 --- a/settings.example.json +++ b/settings.example.json @@ -51,10 +51,10 @@ "enabled": false, "//": "Display coding habits metrics" }, "contributors":{ - "enabled": false, "//": "Display repository contributors" + "enabled": false, "//": "Enable contributors plugin" }, "followup":{ - "enabled": false, "//": "Display follow-up of repositories issues and pull requests" + "enabled": false, "//": "Enable followup plugin" }, "reactions":{ "enabled": false, "//": "Enable reactions plugin" @@ -78,7 +78,7 @@ "enabled": false, "//": "Enable achievements plugin" }, "notable":{ - "enabled": false, "//": "Display notable contributions in organizations" + "enabled": false, "//": "Enable notable plugin" }, "discussions":{ "enabled": false, "//": "Enable discussions plugin"