metrics/source/plugins/base/README.md

🗃️ Base content
Supported features → Full specification	📗 Classic template 📘 Repository template 📙 Terminal template
	👤 Users 👥 Organizations 📓 Repositories
	🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)

➡️ Available options

Type	Description
base	Base content The following sections are supported: header, which usually contains username, two-week commits calendars and a few additional data activity, which contains recent activity (commits, pull requests, issues, etc.) community, which contains community stats (following, sponsors, organizations, etc.) repositories, which contains repositories stats (license, forks, stars, etc.) metadata, which contains informations about generated metrics These are all enabled by default, but it is possible to explicitely opt out from them.
type: array (comma-separated) default: header, activity, community, repositories, metadata allowed values: header activity community repositories metadata
repositories	Repositories to fetch A higher value result in more accurate metrics but can hit GitHub API rate-limit more easily (especially with a lot of plugins enabled)
type: number (0 ≤ 𝑥) default: 100
repositories_batch	Repositories to fetch at a time If you receive Something went wrong while executing your query (which is usually caused by API timeout), try lowering this value.
type: number (1 ≤ 𝑥 ≤ 100) default: 100
repositories_forks	Include forks
type: boolean default: no
repositories_affiliations	Repositories affiliations owner: owned repositories collaborator: repositories with push access organization_member: repositories from an organization where user is a member Some plugin outputs may be affected by this setting too. Set to "" to disable and fetch all repositories related to you. Broad affiliation will result in less representative metrics.
type: array (comma-separated) default: owner allowed values: owner collaborator organization_member
repositories_skipped	Default skipped repositories
⏭️ Global option type: array (comma-separated)
users_ignored	Default ignored users
⏭️ Global option type: array (comma-separated) default: github-actions[bot], dependabot[bot], dependabot-preview[bot]
commits_authoring	Identifiers that has been used for authoring commits Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins
⏭️ Global option ⏯️ Cannot be preset type: array (comma-seperated) default: → User login

ℹ️ Examples workflows

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