repo-digest

README

repo-digest

generate daily digests of repository activity

Synopsis

Generate an HTML digest of repository activity (default stylesheet included). The digest includes two sections: a list of all newly-open pull requests as well as a list of all recently-committed pull requests.

Fetches GitHub data for the specified repository and computes the digest since the --since date. The digest contains two sections including:

Each pull request includes basic information, including title, author, date, and metrics about which subdirectories of the repository are most affected.

Pull requests are ordered by total modification size (additions + deletions).

An access token can be specified via --token. By default, uses an empty token, which is limited to only 50 GitHub requests per hour, rate limited based on IP address.

To generate an access token with authorized rate limits (5000/hr), see:

https://help.github.com/articles/creating-an-access-token-for-command-line-use/

When creating a token, ensure that only the public_repo permission is enabled.

For use against privately hosted github enterprise instances, the root API address can be specified with the --host flag. Note that while the core github API root is specified via subdomain (https://api.github.com/), private enterprise instances generally have an API root specified by URL path (https://github.example.com/api/v3/, for example).

repo-digest

Examples

  repo-digest --repos=cockroachdb/cockroach --token=f87456b1112dadb2d831a5792bf2ca9a6afca7bc

Options

      --alsologtostderr    logs at or above this threshold go to stderr (default NONE)
      --host string        GitHub API hostname, including scheme (default "https://api.github.com/")
      --inline-styles      Inline styles in generated html; good for standalone files (default true)
      --log-backtrace-at   when logging hits line file:N, emit a stack trace (default :0)
      --log-dir            if non-empty, write log files in this directory (default /var/folders/l9/syyh26xj3m70b_h01nxb2_6m0000gn/T/)
      --logtostderr        log to standard error instead of files (default true)
      --no-color           disable standard error log colorization
  -o, --outdir string      Output directory
  -r, --repos value        GitHub repositories, formatted as comma-separated list :owner/:repo[,:owner/:repo,...] (default [])
  -s, --since string       Fetch all opened and closed pull requests since this date (default "2016-05-10T22:46:38-07:00")
  -p, --template string    Go HTML template filename (see templates/ for examples) (default "templates/default")
  -t, --token string       GitHub access token for authorized rate limits
      --verbosity          log level for V logs
      --vmodule            comma-separated list of pattern=N settings for file-filtered logging

SEE ALSO

• repo-digest gendoc - generate markdown documentation

Auto generated by spf13/cobra on 11-May-2016