Issue-Packs

Generate packs of GitHub issues from YAML files

Installation

Requirements:

NodeJS >= 1.1

Run npm install -g issue-pack to install globally

Alternatively, run npm run setup.

Usage

Issue Pack can be used with command prompts where the user enters the information via prompts.

issue-pack

tool: Jira or Github (defaults to Github)
username: Jira/Github Username
password: Jira/Github Password
path: this can be a single issue pack YAML file, a directory containing issue pack YAML files, or multiple issue pack YAML files separated with white-spaces
(Jira) projectKey: Project key of Jira project to import issues to. This is the 1-4 character prefix that prefixes all issues in the project
(Jira) jiraBaseUri: Base URI (eg. https://jira.govready.com or https://govready.atlassian.net)
(Github) repo: Github Repos take the form user/repo (eg. GovReady/Issue-Packs)

Example:

$ issue-pack
tool:  jira
username:  suzyq
password:  
Jira Project Key (prefixes all issues in project):  kan
Jira Base URI (e.g. https://jira.govready.com):  https://myjira.atlassian.net
path:  examples/au_80053_audit_set1.yaml
Unpacking pack: undefined
 - 5 issues unpacked.
Pushing pack to Jira
Issue created: https://myjira.atlassian.net/rest/api/2/issue/10160
Issue created: https://myjira.atlassian.net/rest/api/2/issue/10164
Issue created: https://myjira.atlassian.net/rest/api/2/issue/10161
Issue created: https://myjira.atlassian.net/rest/api/2/issue/10162
Issue created: https://myjira.atlassian.net/rest/api/2/issue/10163
Issues created successfully

Issue Pack can be used with command line arguments in a single command.

Jira Example issue-pack -t=jira -u=test -p=test -k=TEST -b=https://jira.govready.com examples/example-pack2.yml examples/example-pack.yml

tool: -t=jira
username: -u=username
password: -p=username
path: examples/example-pack2.yml examples/example-pack.yml
projectKey: -k=TEST
jiraBaseUri: -b=https://jira.govready.com

Github Example issue-pack -t=github -u=test -p=test -r=repo/repo examples/example-pack2.yml examples/example-pack.yml

tool: -t=jira
username: -u=username
password: -p=username
path: examples/example-pack2.yml examples/example-pack.yml
repo: -r=repo/repo

Issue Pack Format ( YAML )


name: <pack name> # Required
issues: # Required
  -
    title: <issue title> # Required
    body: <issue body text> # Required
    labels: # Optional
      - <tag 1>
      - <tag 2>
  -
    title: <issue title>
    body: <issue body text>
    labels:
      - <tag 1>
      - <tag 2>
  ...

Jira Integration Information

Currently, Issue Pack defaults all issues to issue type "Task" to support all three software development project types: Basic, Kanban, and Scrum.

For this first iteration, basic authentication is used and is recommended to only connect to secure Jira instances.

Development

If you would like to contribute, you will need to be able to compile and run the issue-pack npm module locally

The contribution guidelines are included below, but this blog post is a good starter on the subject.

Please refer to the contribution guidelines below for development build and testing processes.

Contribution Guidelines

The contribution guidelines for this repository can be found in CONTRIBUTING.md.

GovReady / Issue-Packs

readme