octostats

command module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2021 License: MIT Imports: 10 Imported by: 0

README

octostats

Conventional Commits

Get stats for your pull requests on GitHub, including

  • Average time to merge
  • Average number of reviews
  • Number of pull requests with each label

Getting Started

To install and build the project using Powershell Core, run the following

./tools install
./tools build

Authentication

Set the following environment variables for authentication:

  • GITHUB_USER - GitHub login username
  • GITHUB_TOKEN - GitHub personal access token

Read more about creating a personal access token here. For public repositories, you'll need the 'public_repo' scope. To access private repositories, you'll need the complete 'repo' scope. Learn more here.

Usage

octostats owner/repo [ date | -duration ]
Examples

To inspect all your pull requests for a repo,

octostats owner/repo

To inspect your pull requests merged in the last 100 hours,

octostats owner/repo -100h

The duration must be negative. See time.ParseDuration to learn about valid duration formats.

To inspect your pull requests merged since a given date,

octostats owner/repo 2019-07-23

Development

Please read the Contribution Guide before you proceed.

Copyright 2021 Vincent Fiestada. Released under an MIT License.

Icon made by Dave Gandy.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL