Skip to content

jira-github-integ Plugin

This plugin integrates Jira with your GitHub repo.

Usage

Please confirm the preconditions:

  • Jira language must be English
  • There should be an existing Jira project

This plugin depends on the following two environment variables:

  • JIRA_API_TOKEN
  • GITHUB_TOKEN

Set the values accordingly before using this plugin.

If you don't know how to create these tokens, check out: - Creating a personal access token - Manage API tokens for your Atlassian account.

YAML
tools:
  # name of the tool
  - name: jira-github-integ
    # 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
    options:
      # the repo's owner
      owner: YOUR_GITHUB_USERNAME
      # the repo's org. If you set this property, then the new repo will be created under the org you're given, and the "owner" setting above will be ignored.
      org: YOUR_ORGANIZATION_NAME
      # the repo where you'd like to setup GitHub Actions
      repo: YOUR_REPO_NAME
      # "base url: https://id.atlassian.net"
      jiraBaseUrl: https://JIRA_ID.atlassian.net
      # "need real user email in cloud Jira"
      jiraUserEmail: JIRA_USER_EMAIL
      # "get it from project url, like 'HEAP' from https://merico.atlassian.net/jira/software/projects/HEAP/pages"
      jiraProjectKey: JIRA_PROJECT_KEY
      # main branch of the repo (to which branch the plugin will submit the workflows)
      branch: main

Currently, all the parameters in the example above are mandatory.