← Back to plugins index

🎩 Notable contributions

This plugin displays badges for notable contributions on 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
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) read:packages (optional) repo (optional)
Indepth analysis
Contributions in organizations only
## ➡️ Available options
OptionDescription

plugin_notable

Enable notable plugin
✨ On master/main
type: boolean
default: no

plugin_notable_filter

Query filter

Based on GitHub search syntax. Supported fields are stars, forks and watchers

If plugin_notable_indepth is enabled, commits, commits.user, commits.user% and maintainer fields are also supported. Some repositories may not be able to reported advanced stats and in the case the default behaviour will be to bypass filtering
✨ On master/main
type: string

plugin_notable_skipped

Skipped repositories
⏩ Inherits repositories_skipped
✨ On master/main
type: array (newline-separated)

plugin_notable_from

Repository owner account type filter

  • all: no filtering
  • organization: only organization accounts repositories
  • user: only user accounts repositories
✨ On master/main
type: string
default: organization
allowed values:
  • all
  • organization
  • user

plugin_notable_repositories

Repository name

Repositories hosted by user account will always have their full handle displayed
✨ On master/main
type: boolean
default: no

plugin_notable_indepth

Indepth mode
✨ On master/main
🌐 Web instances must configure settings.json:
  • metrics.api.github.overuse
type: boolean
default: no

plugin_notable_types

Contribution types filter

Use a combination of below values to include repositories where:

  • commit: a commit on default branch was made
  • pull_request: a pull request was opened
  • issue: an issue was opened
✨ On master/main
type: array (comma-separated)
default: commit
allowed values:
  • commit
  • pull_request
  • issue

plugin_notable_self

Include own repositories
✨ On master/main
type: boolean
default: no
## 🔎 `indepth` mode The `plugin_notable_indepth` option collects additional stats about your contributions, such as: - Total number of commits within a repository or organization. For each of the above, a badge is awarded. Its color and progress depends of the associated value. ## ℹ️ Examples workflows ```yaml name: Contributions uses: lowlighter/metrics@latest with: filename: metrics.plugin.notable.svg token: ${{ secrets.METRICS_TOKEN }} base: "" plugin_notable: yes ``` ```yaml 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 ```