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

docs: updated workflows examples and options descriptions (#772) [skip ci]

Browse Source
This commit is contained in:
Simon Lecoq
2022-01-14 04:49:14 +01:00
committed by GitHub
parent 44e3992ca9
commit 4d06539136
80 changed files with 2292 additions and 450 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
source/plugins/reactions/README.md
View File

@@ -9,21 +9,42 @@ The *reactions* plugin displays overall reactions on your recent issues and issu
</td>
</table>
#### ➡️ Available options
<!--options-->
| Option | Type *(format)* **[default]** *{allowed values}* | Description |
| ------ | -------------------------------- | ----------- |
| `plugin_reactions` | `boolean` **[no]** | Display average issue comments reactions |
| `plugin_reactions_limit` | `number` **[200]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of issue comments to parse |
| `plugin_reactions_limit_issues` | `number` **[100]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of issues and pull requests opened to parse |
| `plugin_reactions_limit_discussions` | `number` **[100]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of discussions opened to parse |
| `plugin_reactions_limit_discussions_comments` | `number` **[100]** *{0 ≤ 𝑥 ≤ 1000}* | Maximum number of discussions comments opened to parse |
| `plugin_reactions_days` | `number` **[0]** *{0 ≤ 𝑥}* | Maximum comments age |
| `plugin_reactions_display` | `string` **[absolute]** *{"absolute", "relative"}* | Display mode |
| `plugin_reactions_details` | `array` *(comma-separated)* **[]** *{"count", "percentage"}* | Additional details |
| `plugin_reactions_ignored` | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Users to ignore |
Legend for option icons:
* 🔐 Value should be stored in repository secrets
* ✨ New feature currently in testing on `master`/`main`
<!--/options-->
*[→ Full specification](metadata.yml)*
#### ℹ️ Examples workflows
[➡️ Available options for this plugin](metadata.yml)
<!--examples-->
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_reactions: yes
plugin_reactions_limit: 200 # Compute reactions over last 200 issue comments
plugin_reactions_limit_issues: 100 # Compute reactions over last 100 issues/pull requests opened
plugin_reactions_limit_discussions: 100 # Compute reactions over last 100 discussions
plugin_reactions_limit_discussions_comments: 100 # Compute reactions over last 100 discussions comments
plugin_reactions_days: 14 # Compute reactions on issue comments posted less than 14 days ago
plugin_reactions_display: absolute # Display percentages based on the total amoun fetched
plugin_reactions_details: count, percentage # Display reactions count and percentage
plugin_reactions_ignored: bot # Ignore "bot" user
name: 🎭 Comment reactions
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.reactions.svg
token: ${{ secrets.METRICS_TOKEN }}
base: ''
plugin_reactions: 'yes'
plugin_reactions_limit: 100
plugin_reactions_details: percentage
```
<!--/examples-->