README.md

← Back to plugins index
🎟️ Follow-up of issues and pull requests
This plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across repositories.
⚠️ Disclaimer	This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub. All product and company names are trademarks™ or registered® trademarks of their respective holders.
Supported features → Full specification	📗 Classic template 📘 Repository template
	👤 Users 👥 Organizations 📓 Repositories
	🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Indepth analysis Created on a user's repositories Created by a user

➡️ Available options

Option	Description
plugin_followup	Enable followup plugin
type: boolean default: no
plugin_followup_sections	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 (comma-separated) default: repositories allowed values: repositories user
plugin_followup_indepth	Indepth analysis
🌐 Web instances must configure settings.json: metrics.api.github.overuse type: boolean default: no
plugin_followup_archived	Include archived repositories
type: boolean default: yes

🔎 indepth mode

The plugin_followup_indepth option collects additional stats to differentiate issues and pull requests opened by maintainers and users.

It helps knowing whether repositories are also maintained by other users and give an overall health status of repositories.

⚠️ This mode will try to list users with push access to know who are the maintainers in order to place issues in the correct category, which requires a repo scope. If not available, it will consider that only the owner is a maintainer.

ℹ️ Examples workflows

name: Opened on user's repositories
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.followup.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_followup: yes

name: Opened by user
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.followup.user.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_followup: yes
  plugin_followup_sections: user

name: Indepth analysis
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.followup.indepth.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_followup: yes
  plugin_followup_indepth: yes

name: Exclude Archived
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.followup.archived.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_followup: yes
  plugin_followup_archived: no