metrics/source/plugins/activity/README.md

📰 Recent activity

The activity plugin displays your recent activity on GitHub.

It uses data from GitHub events and is able to track the following events:

Event	Description
push	Push of commits
issue	Opening/Reopening/Closing of issues
pr	Opening/Closing of pull requests
ref/create	Creation of git tags or git branches
ref/delete	Deletion of git tags or git branches
release	Publication of new releases
review	Review of pull requests
comment	Comments on commits, issues and pull requests
wiki	Edition of wiki pages
fork	Forking of repositories
star	Starring of repositories
public	Repositories made public
member	Addition of new collaborator in repository

Use a full repo scope token to display private events.

➡️ Available options

Type	Description
plugin_activity	Display recent activity
type: boolean default: no
plugin_activity_limit	Maximum number of events to display
type: number (1 ≤ 𝑥 ≤ 1000) default: 5
plugin_activity_load	Number of events to load
type: number (100 ≤ 𝑥 ≤ 1000) default: 300
plugin_activity_days	Maximum event age
type: number (0 ≤ 𝑥 ≤ 365) default: 14
plugin_activity_filter	Events types to keep
type: array (comma-separated) default: all allowed values: all comment ref/create ref/delete release push issue pr review wiki fork star member public
plugin_activity_visibility	Set events visibility
type: string default: all allowed values: public all
plugin_activity_timestamps	Display events timestamps
type: boolean default: no
plugin_activity_skipped	Repositories to skip
⏩ Inherits repositories_skipped type: array (comma-separated)
plugin_activity_ignored	Actors to ignore
⏩ Inherits users_ignored type: undefined

→ Full specification

ℹ️ Examples workflows

name: Recent activity
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.activity.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_activity: 'yes'
  plugin_activity_limit: 5
  plugin_activity_days: 0
  plugin_activity_filter: issue, pr, release, fork, review, ref/create