README.md

🗃️ 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

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

→ 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