Skip to content

Latest commit

 

History

History
158 lines (149 loc) · 5.39 KB

README.md

File metadata and controls

158 lines (149 loc) · 5.39 KB

🎩 Notable contributions

This plugin displays badges of repositories where you commited at least once on default branch.

Supported features
→ Full specification
📗 Classic template
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
Indepth analysis
Contributions in organizations only

➡️ Available options

TypeDescription

plugin_notable

Enable notable plugin

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

type: string

plugin_notable_skipped

Skipped repositories

⏩ Inherits repositories_skipped
type: array (comma-separated)

plugin_notable_from

Filter by repository owner account type

  • all: no filtering
  • organization: only organization accounts repositories
  • user: only user accounts repositories
type: string
default: organization
allowed values:
  • all
  • organization
  • user

plugin_notable_repositories

Toggle repository name display

Note that Repositories hosted by user account will always be fully displayed

type: boolean
default: no

plugin_notable_indepth

Indepth mode

🌐 Web instances must configure settings.json
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
type: array (comma-separated)
default: commit
allowed values:
  • commit
  • pull_request
  • issue

🔎 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

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