metrics/source/plugins/notable/README.md

🎩 Notable contributions

The notable plugin displays badges of organization where you commited at least once on main branch.

Indepth analysis Contributions in organizations only

Using indepth statistics

The plugin_notable_indepth option lets you get additional metrics about your contribution, such as:

• Total number of commits within a repository or organization. The badge will have a circular gauge which is proportional to the percentage of total contribution. It will also determine the resulting color of the badge.

🔣 On web instances, indepth is an extra feature and must be enabled globally in settings.json

➡️ Available options

Type	Description
plugin_notable	Display notable contributions in organizations
type: boolean default: no
plugin_notable_filter	Query filter
type: string
plugin_notable_from	Filter by repository host account type
type: string default: organization allowed values: all organization user
plugin_notable_repositories	Also display repository name
type: boolean default: no
plugin_notable_indepth	Indepth notable contributions processing
🌐 Web instances must configure settings.json type: boolean default: no

→ Full specification

ℹ️ Examples workflows

name: Contributions
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.notable.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_notable: 'yes'

name: Indepth analysis
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.notable.indepth.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_notable: 'yes'
  plugin_notable_indepth: 'yes'
  plugin_notable_repositories: 'yes'