NodeGH plugin for integrating Jira, an issue management system
JavaScript
Latest commit 7a3e3bd Nov 18, 2015 @henvic henvic Merge pull request #55 from brandizzi/link-to-pull-request-in-comment
Add a link to the JIRA comment pointing to the pull request being reviewed
Failed to load latest commit information.
bin Improving error handling. Nov 5, 2015
test Updating linting options. Apr 6, 2015
.editorconfig Start plugin using gh-boilerplate Sep 13, 2013
.gitignore Ignore node_modules and npm log Sep 13, 2013
.jscsrc Refactoring Jira module. Nov 4, 2015
.jshintrc Refactoring Jira module. Nov 4, 2015
.travis.yml New release 1.0.2. Nov 4, 2015
README.md Simplifying README. Aug 28, 2015
gh-plugin.json
package.json New release v1.0.4. Nov 5, 2015

README.md

GH Jira

NPM version NPM downloads Build Status Dependencies Status DevDependencies Status

NodeGH plugin for integrating Jira, an issue management system.

Maintained by Eduardo Lundgren.

Install

[sudo] npm install -g gh gh-jira

Usage

gh jira

Alias: gh ji

1. Create

Option Usage Type
-N, --new Required Boolean
-p, --project Required String
-t, --title Required String
-A, --assignee Optional String
-C, --component Optional String
-m, --message Optional String
-P, --priority Optional String
-R, --reporter Optional String
-t, --type Optional String
-v, --version Optional String

Examples

  • Create a new issue on a certain project.

    gh jira --new --project LPS --title 'Node GH rocks!' --message 'Body with **Markdown** support'
    
  • Create a new issue specifying the component.

    gh jira --new --project LPS --title 'Node GH rocks!' --component UI
    
  • Create a new, unassigned, issue.

    gh jira --new --project LPS --title 'Node GH rocks!' --unassigned
    
  • Create a new issue and assign it to someone.

    gh jira --new --project LPS --title 'Node GH rocks!' --assignee eduardolundgren
    

2. Comment

Option Usage Type
-c, --comment Required String
-n, --number Required Number

Omitting --number will guess issue number from the last commit message.

Examples

  • Comment on an issue.

    gh jira LPS-123 --comment "Merged, **thank you**!"
    

3. Open in Browser

Option Usage Type
-B, --browser Required Boolean
-n, --number Required Number

Omitting --number will guess issue number from the last commit message.

Examples

  • Open Jira issue page in the browser.

    gh jira LPS-123 --browser
    

4. Transition

Option Usage Type
--transition Required String
-n, --number Required Number
-A, --assignee Optional String
-m, --message Optional String

Omitting --number will guess issue number from the last commit message.

Both Jira and GitHub usernames are supported --assignee values.

Examples

  • Start progress on an issue.

    gh jira LPS-123 --transition "Start Progress"
    
  • Show valid transitions for the issue.

    gh jira LPS-123 --transition
    
  • Show valid transitions for the issue and assign to an user.

    gh jira LPS-123 --assignee brianchandotcom --transition
    
  • Show valid transitions for the issue and unassign it.

    gh jira LPS-123 --unassign --transition
    

Testing

Check Travis for continous integration results.

  • Run JSHint, a tool to detect errors and potential problems.

    npm run-script lint
    
  • Run Mocha, a unit test framework.

    npm run-script test
    

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

Check Release list.

License

BSD License