# gh-jira

> NodeGH plugin for integrating Jira, an issue management system

Latest version **1.0.7** (published 2018-07-26) · BSD license · 0 weekly downloads

## Install

```sh
npm install gh-jira
pnpm add gh-jira
yarn add gh-jira
bun add gh-jira
```

Provides the commands `gh-ji`, `gh-jira`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2018-07-26 |
| First published | 2013-09-30 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12 |
| Dependencies | 3 |
| Unpacked size | 41 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 34 |
| Author | Eduardo Lundgren |
| Maintainers | eduardolundgren, henvic, protoevangelion, zenorocha |
| Keywords | gh, nodegh, jira, plugin |

## Links

- npm: https://www.npmjs.com/package/gh-jira
- Repository: https://github.com/node-gh/gh-jira
- Homepage: https://github.com/node-gh/gh-jira#readme
- Issues: https://github.com/node-gh/gh-jira/issues
- npm.io page: https://npm.io/package/gh-jira

## Dependencies (3)

- [opn](https://npm.io/package/opn.md) ^5.3.0
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [inquirer](https://npm.io/package/inquirer.md) ^0.11.0

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2018-07-26
- 1.0.6 — 2018-06-28
- 1.0.5 — 2016-11-28
- 1.0.4 — 2015-11-05
- 1.0.3 — 2015-11-05
- 1.0.2 — 2015-11-04
- 0.5.8 — 2015-11-04
- 1.0.1 — 2015-11-04
- 1.0.0 — 2015-11-04
- 0.5.7 — 2015-06-22
- 0.5.6 — 2015-05-28
- 0.5.5 — 2015-04-07
- 0.5.3 — 2015-03-13
- 0.5.2 — 2015-03-06
- 0.5.1 — 2015-03-06
- … 11 more at https://npm.io/package/gh-jira/versions

## README

# GH Jira

[![NPM version](http://img.shields.io/npm/v/gh-jira.svg?style=flat)](http://npmjs.org/gh-jira)
[![NPM downloads](http://img.shields.io/npm/dm/gh-jira.svg?style=flat)](http://npmjs.org/gh-jira)
[![Build Status](http://img.shields.io/travis/node-gh/gh-jira/master.svg?style=flat)](https://travis-ci.org/node-gh/gh-jira)
[![Dependencies Status](http://img.shields.io/david/node-gh/gh-jira.svg?style=flat)](https://david-dm.org/node-gh/gh-jira)
[![DevDependencies Status](http://img.shields.io/david/dev/node-gh/gh-jira.svg?style=flat)](https://david-dm.org/node-gh/gh-jira#info=devDependencies)

NodeGH plugin for integrating [Jira](https://www.atlassian.com/software/jira), an issue management system.

> Maintained by [Eduardo Lundgren](https://github.com/eduardolundgren).

## 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.
    * If you would prefer to use the branch as the ticket number you can change this setting in `gh-plugin.json`:

```json
    "inferFromCommitTitle": false,
```

#### 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
    ```

### 5. Status

| Option     | Usage        | Type     |
| ---------- | ------------ | -------- |
| `--status` | **Required** | `String` |

#### Examples

* Show current status of the issue.

    ```
    gh jira LPS-123 --status
    ```


## Testing

Check [Travis](https://travis-ci.org/node-gh/gh-jira) for continuous integration results.

* Run [JSHint](http://www.jshint.com/), a tool to detect errors and potential problems.

    ```
    npm run-script lint
    ```

* Run [Mocha](http://mochajs.org/), 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](https://github.com/node-gh/gh-jira/releases) list.

## License

[BSD License](https://github.com/node-gh/gh/blob/master/LICENSE.md)

---
_Source: https://npm.io/package/gh-jira · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
