YouTrack InCloud 2021.3 Help

Import from GitHub

The new option to import data from GitHub lets you migrate data from a GitHub repository including issues, comments, and users.

In essence, an import configuration is a graphic UI representation of an import script. A setup wizard navigates you through the import configuration process, which covers standard issue settings in GitHub. If your repository has a custom set of fields for issues, you can use an option to directly edit a client GitHub import script in YouTrack itself.

Import Details

If the GitHub database contains references to entities that do not already exist in YouTrack, they are created. The YouTrack user account that you use to run the import should have permissions to create all imported entities. We recommend that you use an account with a System Admin role or the Low-level Admin Write permission to run the import.

Here is the list of entities that are imported from GitHub and their mapping to YouTrack entities:

Entity in GitHubEntity in YouTrack
RepositoryProject
IssuesIssues
CommentsComments
UsersUsers
Custom fieldsCustom fields
AttachmentsAttachments
Markdown files (*.md)Knowledge base articles
HTML files (*.html)Knowledge base articles
reStructuredText files (*.rst)Knowledge base articles
Repository collaboratorsProject team members

Set up an Import from GitHub

Before you add a new import configuration, you need to create a personal access token that will grant access to the target repository in GitHub. Then you can use the token for authorization when setting up the import in YouTrack.

Create an Access Token in GitHub

To set up import of issues from GitHub, you must preliminary create a personal access token for the github account that you use to access issues in GitHub repository.

To create a Personal Access Token in GitHub, please follow the instructions in the GitHub documentation.

The list of Personal access tokens.

We recommend to use the following minimal set of scopes for the token to import GitHub issues depending on the repository type:

  • repo:

    • repo:status

    • public_repo

  • user:

    • read:user

    • user:email

  • repo :To import issues from a private repo, you need to enable the complete set or the repo scopes.

  • user:

    • read:user

    • user:email

Configure Import from GitHub in YouTrack

To configure import from GitHub:

  1. From the Administration menu, select Integrations > Imports.

  2. Click New import to open the setup dialog.

    New import dialog
  3. Select GitHub.

  4. Configure the import settings:

    GitHub import settings
    SettingDescription
    GitHub repository URLThe URL of the target repository. Please note that it is not the clone URL, that is: there should not be .git suffix.
    TokenThe personal access token that you have generated on the GitHub for the user account that you use to access the target issues.

    If required by your GitHub installation, enable the Use SSL key for client authentication option.

    When done, click Next.

  5. Select the target project for the import. For more details about the project mapping configuration, see Project Mapping.

    Optionally, enable the Continuous import toggle. When enabled, YouTrack will periodically poll the GitHub repository and import updated and new issues that were created since the last sync.

    Confirm settings and start import.
  6. When done, click Start import.

    • YouTrack will import found issues, articles, and users into the target YouTrack project.

    • If the Continuous import option is enabled, YouTrack will periodically check target GitHub repository for updated and new issues.

    List of configured import projects.

When you have set up an import, it is shown in the imports list. To view configuration and import details, select an import configuration in the list.

Import configuration details

In the details sidebar, YouTrack shows import status and details on the data that was imported. Click the Resume button in the toolbar, to explicitly start polling for changes and importing updates from the target GitHub repository.

You can also download the import log file to study and investigate when needed.

Project Mapping

On the final step of the import setup, you can choose whether to create a new project for the import or import data into an existing project in YouTrack.

Project Mapping

To configure project mapping:

  1. Select the target YouTrack project.

    • YouTrack checks for existing YouTrack projects with corresponding names. If it finds a YouTrack project with the same name as the GitHub repository, YouTrack suggests it as the target project.

    • If there is no existing YouTrack project with the corresponding name, YouTrack suggests creating a new one.

  2. If you want to change the target project, select another option from the corresponding dropdown on the list.

  3. Click Start import to finalize the import setup.

Edit Import Settings

To edit an existing import configuration:

  1. From the Administration menu, select Integrations > Imports.

  2. In the list of configured imports, select the one you need to edit.

    Details sidebar

  3. In the right sidebar, click the Edit in the toolbar.

  4. While in the edit mode, change the import settings, including the connection settings.

    Edit import settings.

  5. When ready, click Resume import.

    • Your changes will be applied, and YouTrack will poll the target GitHub repository for the updates.

Delete the Import Configuration

To delete an existing import configuration:

  1. From the Administration menu, select Integrations > Imports.

  2. In the list of configured imports, select the one you need to delete.

    Details sidebar

  3. Click the trash icon in the main toolbar of the page, or the Delete button in the right details sidebar.

  4. In the shown dialog, confirm the operation by clicking Delete.

    Confirm delete operation
    • The current import settings are removed.

    • Projects, issues, users, and groups that are already imported remain in YouTrack.

Last modified: 14 July 2021