ContextQMD
Back to Metrics

README

source/plugins/followup/README.md

3.345.1 KB
Original Source
<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">โ† Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>๐ŸŽŸ๏ธ Follow-up of issues and pull requests</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays the ratio of open/closed issues and the ratio of open/merged pull requests across repositories.</p> </td></tr> <tr><th>โš ๏ธ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://github.com">GitHub</a>. All product and company names are trademarksโ„ข or registeredยฎ trademarks of their respective holders.</p> </td></tr> <tr> <th rowspan="3">Supported features <sub><a href="metadata.yml">โ†’ Full specification</a></sub></th> <td><a href="/source/templates/classic/README.md"><code>๐Ÿ“— Classic template</code></a> <a href="/source/templates/repository/README.md"><code>๐Ÿ“˜ Repository template</code></a></td> </tr> <tr> <td><code>๐Ÿ‘ค Users</code> <code>๐Ÿ‘ฅ Organizations</code> <code>๐Ÿ““ Repositories</code></td> </tr> <tr> <td><code>๐Ÿ”‘ (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>read:packages (optional)</code> <code>repo (optional)</code></td> </tr> <tr> <td colspan="2" align="center"> <details open><summary>Indepth analysis</summary></img></details> <details><summary>Created on a user's repositories</summary></img></details> <details><summary>Created by a user</summary></img></details> 
</td>
</tr> </table> <!--/header-->

โžก๏ธ Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_followup</code></h4></td> <td rowspan="2"><p>Enable followup plugin</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_followup_sections</code></h4></td> <td rowspan="2"><p>Displayed sections</p> <ul> <li><code>repositories</code>: overall status of issues and pull requests on your repositories</li> <li><code>user</code>: overall status of issues and pull requests you have created on GitHub</li> </ul> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>array</code> <i>(comma-separated)</i>

<b>default:</b> repositories

<b>allowed values:</b><ul><li>repositories</li><li>user</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_followup_indepth</code></h4></td> <td rowspan="2"><p>Indepth analysis</p> </td> </tr> <tr> <td nowrap="nowrap">๐ŸŒ Web instances must configure <code>settings.json</code>: <ul> <li><i>metrics.api.github.overuse</i></li> </ul> <b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_followup_archived</code></h4></td> <td rowspan="2"><p>Include archived repositories</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> yes

</td> </tr> </table> <!--/options-->

๐Ÿ”Ž 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

<!--examples-->
yaml
name: Opened on user's repositories
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.followup.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ""
  plugin_followup: yes
yaml
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
yaml
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
yaml
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
<!--/examples-->