jira Plugin

This plugin integrates Jira with your GitHub repo.

Usage

The following content is an example of the “tool file”.

For more information on the main config, the tool file and the var file of DevStream, see Core Concepts Overview and DevStream Configuration.

YAML

  1. tools:
  2. # name of the tool
  3. - name: jira
  4.   # id of the tool instance
  5.   instanceID: default
  6.   # format: name.instanceID; If specified, dtm will make sure the dependency is applied first before handling this tool.
  7.   dependsOn: [ ]
  8.   # options for the plugin
  9.   options:
  10.     scm:
  11.       # scm common field
  12.       branch: YOUR_REPO_BRANCH
  13.       token: YOUR_REPO_SCM_TOKEN
  14.       # you can directly use the url of repo (git@github.com/root/test-exmaple.git for example)
  15.       url: YOUR_REPO_URL
  16.       # or you can config detailed fields for this repo
  17.       owner: YOUR_REPO_OWNER
  18.       org: YOUR_REPO_ORG
  19.       name: YOUR_REPO_NAME
  20.       scmType: github
  21.     jira:
  22.       # jira token
  23.       token: JIRA_TOKEN
  24.       # "base url: https://id.atlassian.net"
  25.       baseURL: https://JIRA_ID.atlassian.net
  26.       # "need real user email in cloud Jira"
  27.       userEmail: JIRA_USER_EMAIL
  28.       # "get it from project url, like 'HEAP' from https://merico.atlassian.net/jira/software/projects/HEAP/pages"
  29.       projectKey: JIRA_PROJECT_KEY

Notes:

  • Jira language must be English
  • There should be an existing Jira project
  • scm config option represents codebase location; for more info, you can refer to SCM Config.
  • jira.token should be created before using this plugin; you can refer to Manage API tokens for your Atlassian account.