Files
metrics/source/plugins/activity/metadata.yml
2022-08-14 12:04:03 -04:00

121 lines
2.7 KiB
YAML

name: 📰 Recent activity
category: github
description: |
This plugin displays recent activity on GitHub.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.activity.svg
index: 21
supports:
- user
- organization
- repository
scopes:
- public_access
inputs:
plugin_activity:
description: |
Enable activity plugin
type: boolean
default: no
plugin_activity_limit:
description: |
Display limit
type: number
default: 5
min: 1
max: 1000
plugin_activity_load:
description: |
Events to load
type: number
default: 300
min: 100
max: 1000
plugin_activity_days:
description: |
Events maximum age
type: number
default: 14
min: 0
max: 365
zero: disable
plugin_activity_visibility:
description: |
Events visibility
Can be used to toggle private activity visibility when using a token with `repo` scope
type: string
default: all
values:
- public
- all
plugin_activity_timestamps:
description: |
Events timestamps
type: boolean
default: no
plugin_activity_skipped:
description: |
Skipped repositories
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3, ...
inherits: repositories_skipped
plugin_activity_ignored:
description: |
Ignored users
Can be used to ignore bots activity
type: array
format: comma-separated
default: ""
example: user1, user2, ...
inherits: users_ignored
plugin_activity_filter:
description: |
Events types
These are fetched from [GitHub events API](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/github-event-types) 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`: Changes of wiki pages
- `fork`: Forking of repositories
- `star`: Starring of repositories
- `public`: Repositories made public
- `member`: Addition of new collaborator in repository
type: array
format: comma-separated
default: all
example: issue, pr, review, wiki, star
values:
- all
- comment
- ref/create
- ref/delete
- release
- push
- issue
- pr
- review
- wiki
- fork
- star
- member
- public