Skip to content

Latest commit

 

History

History
174 lines (169 loc) · 5.61 KB

File metadata and controls

174 lines (169 loc) · 5.61 KB

📰 Recent activity

This plugin displays your recent activity on GitHub.

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

➡️ Available options

TypeDescription
plugin_activity

Enable activity plugin

type: boolean
default: no
plugin_activity_limit

Display limit

type: number (1 ≤ 𝑥 ≤ 1000)
default: 5
plugin_activity_load

Events to load

type: number (100 ≤ 𝑥 ≤ 1000)
default: 300
plugin_activity_days

Events maximum age

type: number (0 ≤ 𝑥 ≤ 365)
zero behaviour: disable
default: 14
plugin_activity_visibility

Events visibility

Lets you hide private activity when using a repo scope token

type: string
default: all
allowed values:
  • public
  • all
plugin_activity_timestamps

Display events timestamps

type: boolean
default: no
plugin_activity_skipped

Skipped repositories

⏩ Inherits repositories_skipped
type: array (comma-separated)
plugin_activity_ignored

Ignored users

Useful to ignore bots activity

⏩ Inherits users_ignored
type: array (comma-separated)
plugin_activity_filter

Events types

These are fetched from GitHub events API and the following types are currently supported:

  • 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
type: array (comma-separated)
default: all
allowed values:
  • all
  • comment
  • ref/create
  • ref/delete
  • release
  • push
  • issue
  • pr
  • review
  • wiki
  • fork
  • star
  • member
  • public

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