sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Contributors plugin: Display contributors per contribution category (#443)

Browse Source
This commit is contained in:
Simon Lecoq
2021-08-02 13:41:03 +02:00
committed by GitHub
parent 938bc5c869
commit 2676954194
8 changed files with 148 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
source/plugins/contributors/README.md
View File

@@ -6,7 +6,10 @@ It's especially useful to acknowledge contributors on release notes.
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.svg">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.categories.svg">
<details><summary>Raw list with names</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.svg">
</details>
<details><summary>With number of contributions</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.contributors.contributions.svg">
</details>
@@ -14,6 +17,24 @@ It's especially useful to acknowledge contributors on release notes.
</td>
</table>
**Displaying contributors per categories**
> 🔣 On web instances, sorting contributors per categories is an extra feature and must be enabled globally in `settings.json`
To configure contributions categories, pass a JSON object to `plugin_contributors_categories` (use `|` multiline operator for better readability) with categories names as keys and an array of file glob as values:
```yaml
plugin_contributors_categories: |
{
"📚 Documentation": ["README.md", "docs/**"],
"💻 Code": ["source/**", "src/**"],
"#️⃣ Others": ["*"]
}
```
Each time a file modified by a contributor match a fileglob, they will be added in said category.
Matching is performed in keys order.
#### ℹ️ Examples workflows
[➡️ Available options for this plugin](metadata.yml)
@@ -23,8 +44,9 @@ It's especially useful to acknowledge contributors on release notes.
with:
# ... other options
plugin_contributors: yes
plugin_contributors_base: "" # Base reference (commit, tag, branch, etc.)
plugin_contributors_head: master # Head reference (commit, tag, branch, etc.)
plugin_contributors_ignored: bot # Ignore "bot" user
plugin_contributors_contributions: yes # Display number of contributions for each contributor
plugin_contributors_base: "" # Base reference (commit, tag, branch, etc.)
plugin_contributors_head: main # Head reference (commit, tag, branch, etc.)
plugin_contributors_ignored: bot # Ignore "bot" user
plugin_contributors_contributions: yes # Display number of contributions for each contributor
plugin_contributors_sections: contributors # Display contributors sections
```