Skip to content

mcgrathg/danger-plugin-jira-integration

 
 

Repository files navigation

danger-plugin-jira-integration

npm version semantic-release

Danger plugin to integrate your pull request with JIRA

Usage

Install:

yarn add danger-plugin-jira-integration --dev

At a glance:

// dangerfile.js
import jiraIntegration from "danger-plugin-jira-integration";

jiraIntegration({
  url: "https://myjira.atlassian.net/browse"
});

When JIRA-123 in one of the following:

  • PR title
  • PR body
  • git branch name

then Danger will comment with:

Messages
📖 🔗 JIRA-123

Generated by 🚫 dangerJS

If you'd like to be more specific, you can supply a specific Jira key to match:

jiraIntegration({
  key: "JIRA",
  url: "https://myjira.atlassian.net/browse",
});

This plugin will recognize only issues starting with that key (e.g. JIRA-123) and ignore any other keys (e.g. ABC-321).

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

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.

Contributing

See CONTRIBUTING.md.

About

Danger plugin to link JIRA issue in pull request

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.8%
  • JavaScript 3.5%
  • Shell 0.7%