Skip to content

The repo where we collect AdguardFilters statistics

Notifications You must be signed in to change notification settings

AdguardTeam/AdGuardFiltersStats

Repository files navigation

GitHub Stats CLI App

CLI App that polls data from GitHub REST API, stores it and gives analysis on contributors activity for given repository.

Here's what counts as activity:

  • commit,
  • closed Issue (not marked as Stale),
  • a comment in an Issue or a Pull request,
  • review of a Pull request (regardless of whether it's approved or rejected),
  • merge of a Pull request.

Examples of Github Actions for these scripts can be found in examples folder.

How to install

npm i -g @adguard/github-stats

How to run

Poll events

env \
    COLLECTION_PATH=stats-data \
    GITHUB_TOKEN=token \
    REPO=AdguardTeam/AdguardFilters \
    github-poll

Print stats in console

env \
    COLLECTION_PATH=stats-data \
    GITHUB_TOKEN=token \
    REPO=AdguardTeam/AdguardFilters \
    UNTIL=2022-05-25T15:00:00Z \
    SINCE=2022-05-01T00:00:00Z \
    github-stats

Publish stats to a slack channel

env \
    SLACK_OAUTH_TOKEN=token \
    SLACK_CHANNEL_ID=id \
    COLLECTION_PATH=stats-data \
    REPO=AdguardTeam/AdguardFilters \
    UNTIL=2022-11-22T21:00:00Z \
    SINCE=2022-11-21T21:00:00Z \
    github-publish

Params

  • COLLECTION_PATH — required, path to a jsonl file that stores events
  • GITHUB_TOKEN — optional, Github Personal Access Token. API rate is limited to 60 requests an hour if not provided.
  • REPO — required, path to a Github repository as {owner}/{repo_name}
  • UNTIL — optional, timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SS. Defaults to now.
  • SINCE — optional, timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SS. All stored events will be used if not provided.

Additional params for publishing

  • SLACK_OAUTH_TOKEN — required, Slack App token
  • SLACK_CHANNEL_ID — required, channel id to post messages to

About

The repo where we collect AdguardFilters statistics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published