Skip to content

Latest commit

 

History

History
215 lines (210 loc) · 7.64 KB

README.md

File metadata and controls

215 lines (210 loc) · 7.64 KB
Raw
← Back to plugins index

🗃️ Base content

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

➡️ Available options

OptionDescription

base

Base content

The following sections are supported:

  • header, which usually contains username, two-weeks 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 repository stats (license, forks, stars, etc.)
  • metadata, which contains information about generated metrics

These are all enabled by default, but it is possible to explicitly opt out from them.
type: array (comma-separated)
default: header, activity, community, repositories, metadata
allowed values:
  • header
  • activity
  • community
  • repositories
  • metadata

base_indepth

Indepth mode

Enabling this will consume additional API queries to fetch more data. This currently improves the accuracy of the following statistics:

  • total commits
  • total issues
  • total pull requests
  • total pull requests reviews
  • total repositories contributed to
🌐 Web instances must configure settings.json:
  • metrics.api.github.overuse
type: boolean
default: no

base_hireable

Show Available for hire! in header section
type: boolean
default: no

base_skip

Skip base content

⚠️ Any plugin that relies on base content data may break! Only use this option when using a plugin that can be configured with token: NOT_NEEDED
type: boolean
default: no

repositories

Fetched repositories

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

Fetched repositories per query

If you receive Something went wrong while executing your query (which is usually caused by API timeouts), lowering this value may help. This setting may not be supported by all plugins.
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 given account. Broad affiliations 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 (newline-separated)

users_ignored

Default ignored users

Note that emails are only supported in commits-related elements.
⏭️ Global option
type: array (comma-separated)
default: github-actions[bot], dependabot[bot], dependabot-preview[bot], actions-user, action@github.com

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-separated)
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