Documentation

GitHub

Measure a development team's output (commits, PRs, reviews) and GitHub Actions CI status from a pipeline.

The GitHub integration gives your pipelines a read of development activity: commits, pull requests, reviews, and GitHub Actions runs — by repository and by developer. It is read-only: nothing is written to your repositories.

What you can do with it

  • Team output report — who shipped what over the period: commits, lines added / deleted, PRs opened and merged, number of reviews.
  • CI health — number of successful, failed and in-progress GitHub Actions runs, per repository.
  • Feed an agent — an agent that summarizes the technical week (see Use cases → CTO IA).

Connection

In Settings → Services → GitHub, Accounts tab, two methods:

  1. Connect with GitHub — OAuth via the platform's application (when the operator has configured it), then selection of the repositories to track. No token to copy.
  2. Paste a token (BYO) — a read-only GitHub access token (ideally a fine-grained PAT limited to the relevant repositories), the list of repositories to track (owner/repo) and, for GitHub Enterprise, an API base URL. The token is stored server-side and never shown again.

The github_report node

The github_report node fetches activity over a time window (24h, 7d or 30d) and publishes it into the context: breakdown by developer (by_developer) and by repository (by_repo), commit log (commit_log), totals, CI summary (ci), and the list of repositories that could not be read (unreadable_repos). A downstream agent turns it into a readable report.

Reads are run in parallel (with a bound) across repositories, to stay fast on a busy GitHub organization.

Agent tools (read): github.report, github.list_commits, github.list_pull_requests.

Best practices

  • Prefer a dedicated token for the integration over a shared personal token.
  • Restrict scopes to the strict minimum (read access to repositories, pull requests and actions).
  • Combine with the Schedule channel for a recurring report (e.g. every evening at 6pm).