hagen

command module
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2020 License: Apache-2.0 Imports: 1 Imported by: 0

README

Hagen

Quality Gate Status Go Report Card

Tom Hagen

CLI application for getting information out of GitHub, mainly for running a sprint and generating a burn down and creating changelogs.

CLI application for retrieving data from GitHub

Usage:
  hagen [command]

Available Commands:
  help        Help about any command
  issues      List issues given the search criteria

Flags:
      --config string   config file (default is $HOME/.benmatselby/hagen.yaml)
  -h, --help            help for hagen

Use "hagen [command] --help" for more information about a command.

Requirements

Configuration

There are two aspects to configuring hagen.

Environment variables

In order to connect to GitHub hagen requires two environment variables.

export GITHUB_OWNER=""
export GITHUB_TOKEN=""

The token can be generated by reading this article. Typically the GITHUB_OWNER will be your username.

Configuration file

hagen tries to save on typing, so you can define some queries in a configuration file.

templates:
  sprint:
    query: "state:open project:acme/14"
    count: 200
  open-bugs:
    query: "repo:benmatselby/donny state:open"
    count: 50

To understand how to write the query section, follow this article.

Installation via Git

git clone git@github.com:benmatselby/hagen.git
cd hagen
make all
./hagen

You can also install into your $GOPATH/bin by go install

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

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