jira

package module
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Jan 29, 2016 License: Apache-2.0 Imports: 24 Imported by: 0

README

go-jira

simple command line client for Atlassian's Jira service written in Go

Synopsis

jira ls -p GOJIRA                       # list all unresolved issues for project GOJRIA
jira ls -p GOJIRA -a mothra             # as above also assigned to user mothra
jira ls -p GOJIRA -w mothra             # lists GOJIRA unresolved issues watched by user mothra
jira ls -p GOJIRA -r mothra             # list GOJIRA unresolved issues reported by user mothra
jira ls -t table -p GOJIRA              # list all unresolved issues in pretty table output

jira view GOJIRA-321                    # print Issue using "view" template
jira GOJIRA-321                         # same as above

jira edit GOJIRA-321                    # open up the issue in an editor, when you exit the
                                        # editor the issue will post the updates to the server

# edit the issue, using the overirdes on the command line, skip the interactive editor:
jira edit GOJIRA-321 --noedit \
     -o assignee=mothra \
     -o comment="mothra, please take care of this." \
     -o priority=Major

jira create -p GOJIRA                   # create new "Bug" type issue for project GOJIRA
jira create -p GOJIRA -i Task           # create new Task type issue

jira trans close GOJIRA-321             # close issue, with interactive editor to set fields
jira close GOJIRA-321 --edit            # same as above

# close the issue, set the resolution, and skip interactive editor:
jira trans close GOJIRA-321 -o resolution="Won't Fix" --noedit
# same as above
jira close GOJIRA-321 -o resolution="Won't Fix"

jira repopen GOJIRA-321 -m "reopening"  # reopen issue

jira watch GOJIRA-321                   # add self as watcher to the issue

jira comment GOJIRA-321 -m "done yet?"  # add comment to the issue

jira take GOJIRA-321                    # assign issue to self

jira give GOJIRA-321 mothra             # assign issue to user mothra

# create local project config to set defaults
mkdir .jira.d
echo "project: GOJIRA" > .jira.d/config.yml

jira ls                                 # list all unresolved issues for project GOJRIA
jira ls -a mothra                       # as above also assigned to user mothra
jira ls -w mothra                       # lists GOJIRA unresolved issues watched by user mothra
jira ls -r mothra                       # list GOJIRA unresolved issues reported by user mothra
jira ls -t table                        # list all unresolved issues in pretty table output

jira create                             # create new "Bug" type issue for project GOJIRA
jira create -i Task                     # create new Task type issue

# make the table template your default "list" template:
jira export-templates -t table
mv $HOME/.jira.d/templates/table $HOME/.jira.d/templates/list

Download

You can download one of the pre-built binaries for go-jira here.

Build

  • NOTE You will need go-1.4.1 minimum

  • If you do not have a GOPATH setup, these are simple build steps:

git clone git@github.com:Netflix-Skunkworks/go-jira.git
cd go-jira
export GOPATH=$(pwd)
export GOBIN=$GOPATH/bin
export PATH=$GOBIN:$PATH
cd src/github.com/Netflix-Skunkworks/go-jira/jira
go get -v
  • If you do have a GOPATH setup, these are the standard steps to build:
cd $GOPATH
git clone git@github.com:Netflix-Skunkworks/go-jira.git src/github.com/Netflix-Skunkworks/go-jira
cd src/github.com/Netflix-Skunkworks/go-jira/jira
go get -v

Configuration

go-jira uses a configuration hierarchy. When loading the configuration from disk it will recursively look through all parent directories in your current path looking for a .jira.d directory. If your current directory is not a child directory of your homedir, then your homedir will also be inspected for a .jira.d directory. From all of .jira.d directories discovered go-jira will load a config.yml if found. The configuration properties found in a file closests to your current working directory will have precedence. Properties overriden with command line options will have final precedence.

The complicated configuration heirarchy is used because go-jira attempts to be context aware. For example, if you are working on a "foo" project and you cd into your project workspace, wouldn't it be nice if jira ls automatically knew to list only issues related to the "foo" project? Likewise when you cd to the "bar" project then jira ls should only list issues related to "bar" project. You can do this with by creating a configuration under your project workspace at ./.jira.d/config.yml that looks like:

project: foo

You will need to specify your local jira endpoint first, typically in your homedir like:

mkdir ~/.jira.d

cat <<EOM >~/.jira.d/config.yml
endpoint: https://jira.mycompany.com
EOM
Dynamic Configuration

If the .jira.d/config.yml file is executable, then go-jira will attempt to execute the file and use the stdout for configuration. You can use this to customize templates or other overrides depending on what type of operation you are running. For example if you would like to use the "table" template when ever you run jira ls, then you can create a template like this:

#!/bin/sh

echo "endpoint: https://jira.mycompany.com"
echo "editor: emacs -nw"

case $JIRA_OPERATION in 
    list)
      echo "template: table";;
esac

Or if you always set the same overrides when you create an issue for your project you can do something like this:

#!/bin/sh
echo "project: GOJIRA"

case $JIRA_OPERATION in
    create)
        echo "assignee: $USER"
        echo "watchers: mothra"
        ;;
esac
Editing

When you run command like jira edit it will open up your favorite editor with the templatized output so you can quickly edit. When the editor closes go-jira will submit the completed form. The order which go-jira attempts to determine your prefered editor is:

  • editor property in any config.yml file
  • JIRA_EDITOR environment variable
  • EDITOR environment variable
  • vim
Templates

go-jira has the ability to customize most output (and editor input) via templates. There are default templates available for all operations, which may or may not work for your actual jira implementation. Jira is endlessly customizable, so it is hard to provide default templates that will work for all issue types.

When running a command like jira edit it will look through the current directory hierarchy trying to find a file that matches .jira.d/templates/edit, if found it will use that file as the template, otherwise it will use the default edit template hard-coded into go-jira. You can export the default hard-coded templates with jira export-templates which will write them to ~/.jira.d/templates/.

Usage

Usage:
  jira (ls|list) <Query Options> 
  jira view ISSUE
  jira edit [--noedit] <Edit Options> [ISSUE | <Query Options>]
  jira create [--noedit] [-p PROJECT] <Create Options>
  jira DUPLICATE dups ISSUE
  jira BLOCKER blocks ISSUE
  jira watch ISSUE [-w WATCHER]
  jira (trans|transition) TRANSITION ISSUE [--noedit] <Edit Options>
  jira ack ISSUE [--edit] <Edit Options>
  jira close ISSUE [--edit] <Edit Options>
  jira resolve ISSUE [--edit] <Edit Options>
  jira reopen ISSUE [--edit] <Edit Options>
  jira start ISSUE [--edit] <Edit Options>
  jira stop ISSUE [--edit] <Edit Options>
  jira comment ISSUE [--noedit] <Edit Options>
  jira take ISSUE
  jira (assign|give) ISSUE ASSIGNEE
  jira fields
  jira issuelinktypes
  jira transmeta ISSUE
  jira editmeta ISSUE
  jira issuetypes [-p PROJECT] 
  jira createmeta [-p PROJECT] [-i ISSUETYPE] 
  jira transitions ISSUE
  jira export-templates [-d DIR] [-t template]
  jira (b|browse) ISSUE
  jira login
  jira ISSUE

General Options:
  -b --browse         Open your browser to the Jira issue
  -e --endpoint=URI   URI to use for jira
  -h --help           Show this usage
  -t --template=FILE  Template file to use for output/editing
  -u --user=USER      Username to use for authenticaion (default: $USER)
  -v --verbose        Increase output logging

Query Options:
  -a --assignee=USER        Username assigned the issue
  -c --component=COMPONENT  Component to Search for
  -f --queryfields=FIELDS   Fields that are used in "list" template: (default: summary,created,updated,priority,status,reporter,assignee)
  -i --issuetype=ISSUETYPE  The Issue Type
  -l --limit=VAL            Maximum number of results to return in query (default: 500)
  -p --project=PROJECT      Project to Search for
  -q --query=JQL            Jira Query Language expression for the search
  -r --reporter=USER        Reporter to search for
  -s --sort=ORDER           For list operations, sort issues (default: priority asc, created)
  -w --watcher=USER         Watcher to add to issue (default: $USER)
                            or Watcher to search for

Edit Options:
  -m --comment=COMMENT      Comment message for transition
  -o --override=KEY=VAL     Set custom key/value pairs

Create Options:
  -i --issuetype=ISSUETYPE  Jira Issue Type (default: Bug)
  -m --comment=COMMENT      Comment message for transition
  -o --override=KEY=VAL     Set custom key/value pairs

Command Options:
  -d --directory=DIR        Directory to export templates to (default: $HOME/.jira.d/templates)

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	VERSION string
)

Functions

func FindClosestParentPath 

func FindClosestParentPath(fileName string) (string, error)

func FindParentPaths 

func FindParentPaths(fileName string) []string

func RunTemplate 

func RunTemplate(templateContent string, data interface{}, out io.Writer) error

Types

type Cli 

type Cli struct {
	// contains filtered or unexported fields
}

func New 

func New(opts map[string]interface{}) *Cli

func (*Cli) Browse 

func (c *Cli) Browse(issue string) error

func (*Cli) CmdAssign 

func (c *Cli) CmdAssign(issue string, user string) error

func (*Cli) CmdBlocks 

func (c *Cli) CmdBlocks(blocker string, issue string) error

func (*Cli) CmdComment 

func (c *Cli) CmdComment(issue string) error

func (*Cli) CmdComponent added in v0.1.0 

func (c *Cli) CmdComponent(action string, project string, name string, desc string, lead string) error

func (*Cli) CmdComponents added in v0.1.0 

func (c *Cli) CmdComponents(project string) error

func (*Cli) CmdCreate 

func (c *Cli) CmdCreate() error

func (*Cli) CmdCreateMeta 

func (c *Cli) CmdCreateMeta() error

func (*Cli) CmdDups 

func (c *Cli) CmdDups(duplicate string, issue string) error

func (*Cli) CmdEdit 

func (c *Cli) CmdEdit(issue string) error

func (*Cli) CmdEditMeta 

func (c *Cli) CmdEditMeta(issue string) error

func (*Cli) CmdExportTemplates 

func (c *Cli) CmdExportTemplates() error

func (*Cli) CmdFields 

func (c *Cli) CmdFields() error

func (*Cli) CmdIssueLinkTypes 

func (c *Cli) CmdIssueLinkTypes() error

func (*Cli) CmdIssueTypes 

func (c *Cli) CmdIssueTypes() error

func (*Cli) CmdLabels 

func (c *Cli) CmdLabels(action string, issue string, labels []string) error

func (*Cli) CmdList 

func (c *Cli) CmdList() error

func (*Cli) CmdLogin 

func (c *Cli) CmdLogin() error

func (*Cli) CmdRequest 

func (c *Cli) CmdRequest(uri, content string) (err error)

func (*Cli) CmdTransition 

func (c *Cli) CmdTransition(issue string, trans string) error

func (*Cli) CmdTransitionMeta 

func (c *Cli) CmdTransitionMeta(issue string) error

func (*Cli) CmdTransitions 

func (c *Cli) CmdTransitions(issue string) error

func (*Cli) CmdView 

func (c *Cli) CmdView(issue string) error

func (*Cli) CmdVote added in v0.1.0 

func (c *Cli) CmdVote(issue string, up bool) error

func (*Cli) CmdWatch 

func (c *Cli) CmdWatch(issue string, watcher string, remove bool) error

func (*Cli) FindIssues 

func (c *Cli) FindIssues() (interface{}, error)

func (*Cli) GetOptBool added in v0.1.0 

func (c *Cli) GetOptBool(optName string, dflt bool) bool

func (*Cli) GetOptString added in v0.1.0 

func (c *Cli) GetOptString(optName string, dflt string) string

func (*Cli) GetTemplate 

func (c *Cli) GetTemplate(name string) string

func (*Cli) SaveData 

func (c *Cli) SaveData(data interface{}) error

func (*Cli) ViewIssue 

func (c *Cli) ViewIssue(issue string) (interface{}, error)

type NoChangesFound 

type NoChangesFound struct{}

func (NoChangesFound) Error 

func (f NoChangesFound) Error() string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.