Skip to content

jira Plugin

This plugin integrates Jira with your GitHub repo.


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.

# name of the tool
- name: jira
  # id of the tool instance
  instanceID: default
  # format: name.instanceID; If specified, dtm will make sure the dependency is applied first before handling this tool.
  dependsOn: [ ]
  # options for the plugin
      # scm common field
      branch: YOUR_REPO_BRANCH
      token: YOUR_REPO_SCM_TOKEN
      # you can directly use the url of repo ( for example)
      url: YOUR_REPO_URL
      # or you can config detailed fields for this repo
      owner: YOUR_REPO_OWNER
      org: YOUR_REPO_ORG
      name: YOUR_REPO_NAME
      scmType: github
      # jira token
      token: JIRA_TOKEN
      # "base url:"
      # "need real user email in cloud Jira"
      userEmail: JIRA_USER_EMAIL
      # "get it from project url, like 'HEAP' from"
      projectKey: JIRA_PROJECT_KEY


  • 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.