metrics/source/plugins/base

🗃️ Base content

The base content is all metrics enabled by default.

It contains the following sections:

• header, which usually contains your username, your two-week commits calendars and a few additional data
• activity, which contains your recent activity (commits, pull requests, issues, etc.)
• community, which contains your community stats (following, sponsors, organizations, etc.)
• repositories, which contains your repositories stats (license, forks, stars, etc.)
• metadata, which contains informations about generated metrics

These are all enabled by default, but you can explicitely opt out from them.

➡️ Available options

Option	Type (format) [default] {allowed values}	Description
base	array (comma-separated) [header, activity, community, repositories, metadata] {"header", "activity", "community", "repositories", "metadata"}	Metrics base content
repositories	number [100] {0 ≤ 𝑥}	Number of repositories to use
repositories_batch	number [100] {1 ≤ 𝑥 ≤ 100}	Number of repositories to load at once by queries
repositories_forks	boolean [no]	Include forks in metrics
repositories_affiliations	array (comma-separated) [owner] {"owner", "collaborator", "organization_member"}	Repositories affiliations
repositories_skipped ⏭️	array (comma-separated) []	Default repositories to skip
users_ignored ⏭️ ✨	array (comma-separated) [github-actions[bot], dependabot[bot], dependabot-preview[bot]]	Default users to ignore
commits_authoring ⏭️	array (comma-seperated) [→ User login]	List of surnames or email addresses you use when authoring commits

Legend for option icons:

• ⏭️ Value be inherited by its related plugin-level option
• ✨ Currently in beta-testing on master/main

→ Full specification

ℹ️ Examples workflows

name: Default metrics
uses: lowlighter/metrics@latest
with:
  filename: metrics.base.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: header, activity, community, repositories, metadata