sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: remove cost, document missing options and improve docs (#653)

Browse Source
This commit is contained in:
Simon Lecoq
2021-11-04 19:33:29 -04:00
committed by GitHub
parent e147d2ac32
commit a291e35774
56 changed files with 82 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
source/plugins/activity/README.md
View File

@@ -38,7 +38,11 @@ Use a full `repo` scope token to display **private** events.
with:
# ... other options
plugin_activity: yes
plugin_activity_limit: 5 # Limit to 5 events
plugin_activity_days: 14 # Keep only events from last 14 days (can be set to 0 to disable limitations)
plugin_activity_filter: all # Show all events (use table above to filter events types)
plugin_activity_limit: 5 # Limit to 5 events
plugin_activity_load: 100 # Load up to 100 recent events from API (should be higher than "limit")
plugin_activity_days: 14 # Keep only events from last 14 days (set to 0 for no limit)
plugin_activity_filter: all # Show all events (use table above to filter events types)
plugin_activity_visibility: public # Only display public events
plugin_activity_timestamps: yes # Display events timestamps
plugin_activity_skipped: repo # Ignored repositories
```

3
source/plugins/activity/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "📰 Recent activity"
cost: 1 REST request per 100 events
category: github
index: 16
supports:
@@ -86,4 +85,4 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...