Importing data from Github

The Jira Importers plugin, which is bundled with Jira, allows you to import data from GitHub by connecting to a live GitHub database.

The GitHub importer is compatible with Jira 6.1 and above.

(info) Our main website highlights some top reasons why people migrate from GitHub to Jira.

The GitHub import process consists of running the GitHub Import Wizard, which will step you through the process to connect to GitHub, and map and import your data to Jira. The GitHub importer will connect to GitHub using your GitHub username and password (which you must provide) or with a Personal Access Token. If you are using GitHub Enterprise, you will also have to provide your GitHub Enterprise URL (which you can obtain in GitHub under your Enterprise Settings). The GitHub importer will be able to access and import data from your personal and public repositories, and any other repositories that you have starred, so you should make sure you've starred any other repositories you want to import data from. You don't have to select all your personal, public and starred repositories, the GitHub importer will display all repositories it can access and you can pick and choose which ones you want to import. If your GitHub instance has 2 factor authentication, you will be required to either provide the 6 digit access code that you will be sent, or a back-up code.

(info) If you have attachments in GitHub and you want to import these too, you must ensure you have attachments enabled in Jira. Attachments are enabled by default.

Running the GitHub Import Wizard

If your Jira installation has existing data, then before you begin, back up your existing Jira data.

  1. Log in to Jira as a user with the Jira Administrators global permission.
  2. Choose > System. Select Import & Export > External System Import to open the Import external projects page. 
  3. Select GitHub to open the GitHub Import Wizard.
  4. On the GitHub Setup page, select which type of GitHub you are using. If you are using GitHub Enterprise you will also be required to provide your GitHub Enterprise URL. You also need to provide either your GitHub username and password, or a GitHub Personal Access Token. Note if you have used the GitHub import wizard before and saved a previous configuration file, you can select the configuration file here to speed up your import.

  5. Click Next.

    Have 2 factor authentication? Click here..

    If you have 2 factor authentication on your GitHub account, you will be prompted to enter your 6 digit code now, and then click Next.

     The Authentication page displays, verifying your authentication has been successful. 

  6. Click Next. The Map projects page displays, and will show a list of all your public and private repositories, as well as any repositories you have starred.
  7. On the Map projects page, select the repositories you want to import data from, and where you want to import it to.
    (info) All GitHub projects are initially set to "Don't import this project". To import a repository, you must either select an existing compatible project to import the data to, or create a new project.

    To create a new project, select Create New from the drop-down menu and in the resulting Add A New Project dialog box, type the following:
      1. A new project Name
      2. A new project Key 
        (info) This will be used as the prefix for all issue IDs in your Jira project.
      3. The Project Lead.
  8. Click Next. The Fetching Data page will display, updating you on the progress of your import.
  9. The Labels page will display when your import has completed. As GitHub only uses labels, you can now map the labels to an issue type and/or a resolution. You do not have to map every label, and if you would like to create Jira labels to correspond to the GitHub labels you have not mapped, ensure the "Add Jira labels..." tick box is checked.
  10. Click Begin import.

  11. Success! You have completed importing your GitHub data to Jira. If there were any errors or warnings, these will be displayed to make you aware that you may need to check some details.

    (info) Note: 
    • If you experience problems with the import (or you are curious), click the download a detailed log link to reveal detailed information about the GitHub Import Wizard process.
    • If you need to import data from another GitHub repository with the same (or similar) settings to what you used through this procedure, click the save the configuration link to download a GitHub configuration file (this will be a text file), which you can use at the first step of the GitHub Import Wizard.

Congratulations, you have successfully imported your GitHub repository data into Jira! If you have any questions or encounter any problems, please contact Atlassian support.

Last modified on Mar 26, 2019

Was this helpful?

Provide feedback about this article
Powered by Confluence and Scroll Viewport.