doc(plugins/followup): update

This commit is contained in:
lowlighter
2022-01-15 22:36:33 -05:00
parent a22c93cceb
commit 34203e9a07
2 changed files with 51 additions and 31 deletions

View File

@@ -1,5 +1,10 @@
name: "🎟️ Follow-up of issues and pull requests"
category: github
description: This plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across all your repositories.
examples:
+indepth analysis: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.indepth.svg
created on an user's repositories: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.svg
created by an user: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.user.svg
index: 7
supports:
- user
@@ -9,25 +14,25 @@ scopes:
- public_access
inputs:
# Enable or disable plugin
plugin_followup:
description: Display follow-up of repositories issues and pull requests
description: Enable followup plugin
type: boolean
default: no
# Sections to display
plugin_followup_sections:
description: Sections to display
description: |
Displayed sections
- `repositories`: overall status of issues and pull requests on your repositories
- `user`: overall status of issues and pull requests you have created on GitHub
type: array
format: comma-separated
default: repositories
values:
- repositories # Overall status of issues and pull requests on your repositories
- user # Overall status of issues and pull requests you have created on GitHub
- repositories
- user
# 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
type: boolean
default: no
extras: yes