https://github.com/macklinu/danger-plugin-jira-issue

Danger plugin to link JIRA issue in pull request
https://github.com/macklinu/danger-plugin-jira-issue

ci code-review danger danger-plugin jira

Last synced: about 1 month ago
JSON representation

Danger plugin to link JIRA issue in pull request

• Host: GitHub
• URL: https://github.com/macklinu/danger-plugin-jira-issue
• Owner: macklinu
• License: mit
• Created: 2017-05-11T20:32:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-10-12T18:21:38.000Z (about 6 years ago)
• Last Synced: 2023-07-27T01:03:16.860Z (over 1 year ago)
• Topics: ci, code-review, danger, danger-plugin, jira
• Language: TypeScript
• Homepage:
• Size: 819 KB
• Stars: 19
• Watchers: 2
• Forks: 11
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-danger - danger-plugin-jira-issue - Danger plugin to link JIRA issue in pull request. (Plugins / TypeScript (danger-js))

README

        
# danger-plugin-jira-issue

[![Build Status](https://travis-ci.org/macklinu/danger-plugin-jira-issue.svg?branch=master)](https://travis-ci.org/macklinu/danger-plugin-jira-issue)

[![npm version](https://badge.fury.io/js/danger-plugin-jira-issue.svg)](https://badge.fury.io/js/danger-plugin-jira-issue)

> [Danger](https://github.com/danger/danger-js) plugin to link JIRA issue in pull request

## Usage

Install:

```sh

yarn add danger-plugin-jira-issue --dev

```

At a glance:

```js

// dangerfile.js

import jiraIssue from "danger-plugin-jira-issue";

jiraIssue({

  key: "JIRA",

  url: "https://myjira.atlassian.net/browse",

  emoji: ":paperclip:",

  format(emoji, jiraUrls) {

    // Optional Formatter

    return "Some Custom Message";

  },

  location: "title" // Optional location, either 'title' or 'branch'

});

```

With JIRA-123 in the PR title, Danger will comment with:

  

    

      

      Messages

    

  

  

      :book:

      :paperclip: JIRA-123

    

  



  Generated by :no_entry_sign: dangerJS



If you work with multiple JIRA project boards, you can supply multiple project keys:

```js

jiraIssue({

  key: ["ABC", "DEF"],

  url: "https://myjira.atlassian.net/browse"

});

```

This plugin will recognize issues starting with those keys (e.g. `ABC-123` and `DEF-234`).

## Changelog

See the GitHub [release history](https://github.com/macklinu/danger-plugin-jira-issue/releases).

## Development

Install [Yarn](https://yarnpkg.com/en/), and install the dependencies - `yarn install`.

Run the [Jest](https://facebook.github.io/jest/) test suite with `yarn test`.

This project uses [semantic-release](https://github.com/semantic-release/semantic-release) for automated NPM package publishing.

:heart: