Connect or disconnect a Reltio tenant to Git repository
Learn how to connect a Reltio tenant to a branch of a Git repository, and how to disconnect it, in the integrated development experience.
Connect a Reltio tenant to Git to track its configuration changes, review them in pull requests, and promote them between Reltio tenants. The connection links the Reltio tenant to one branch of a remote Git repository. Connect each Reltio tenant separately. Disconnect a Reltio tenant when you no longer want to track its configuration in Git.
The following roles can connect and disconnect a Reltio tenant:
Prerequisites
Before you connect a Reltio tenant, confirm the following requirements:
-
A Reltio tenant that you connected to the integrated development experience.
-
The folder that you opened when you connected the Reltio tenant, open in your editor. This folder contains a folder for each environment, for example
devandprod. Open this folder, not an environment or tenant folder inside it, because the integrated development experience stores its supporting files here. -
Git installed on your computer and signed in to your Git host. Download Git from git-scm.com/downloads.
-
The URL of a remote Git repository on your Git host, for example on GitHub, GitLab, Bitbucket, or Azure DevOps. The Git repository can be empty. You need read access to connect and write access to push changes. You can use one Git repository for all your Reltio tenants, with one branch for each Reltio tenant, or a separate Git repository for each Reltio tenant.
- In the business configuration tree of the Reltio IDE extension view, right-click the Reltio tenant and select Connect to Git.
If the workspace folder or one of its parent folders is already a Git repository, the integrated development experience warns you in a dialog box. The warning appears when you open the workspace and when you connect a Reltio tenant. It offers the following choices:
Choice What it does Ignore Tenant Folders Stops the other Git repository from tracking your Reltio tenant files. Files that it already tracks stay tracked until you remove them from it. For more information, see Tenant files appear in another Git repository. Show Details Opens an explanation of the problem and your options. Don't Show Again Stops the warning for this workspace. Select it if you keep the whole workspace in one Git repository on purpose. Connect Anyway Appears in the dialog box that opens when you connect a Reltio tenant. Initializes a local Git repository for the Reltio tenant inside the other Git repository. Select it only if you intend to do so. Figure 1. Connect to Git option in the tenant context menu - Choose a branch for the Reltio tenant.
The integrated development experience reads the list of branches from your Git repository without downloading anything. Do one of the following:
-
To use an existing branch, select it from the list.
-
To create a branch, select Create a new branch…, enter a name, for example
dev, and select Create Branch in the dialog box that asks you to confirm the branch.
If the Git repository has no branches, or the list is unavailable, a dialog box asks you to enter the branch name instead.
Figure 2. Branch list for connecting a tenant to Git A Connecting tenant to Git… notification shows the progress.
The integrated development experience connects the Reltio tenant and shows the branch next to the tenant name in the business configuration tree, for example
TenantDev123 ⎇ dev. If you change the branch in a terminal or in the Source Control view, the business configuration tree shows the new branch. The result depends on the branch that you chose. The following table describes each situation:Situation What the integrated development experience does Your action You chose an existing branch Connects the Reltio tenant to the branch and keeps your configuration as it is. The configuration appears as changes against the branch. Review the changes in the Source Control view, and then commit and push them. You entered a new branch name Creates the branch from the default branch of the Git repository, publishes it, and shows a message that the branch is created and pushed. Your configuration appears as changes against the new branch. Review the changes in the Source Control view, and then commit and push them. The Git repository is empty and has no branches Connects the Reltio tenant to the branch name that you entered and shows a message that the remote Git repository is empty. The branch does not exist in the remote Git repository yet. Commit the configuration of the Reltio tenant in the Source Control view, and then push it. The push creates the branch in the remote Git repository, and your configuration becomes its first commit. You did not confirm the new branch Does not create the branch and shows a message that the Reltio tenant is not connected to Git. Connect the Reltio tenant again and confirm the branch, or choose an existing branch. A new branch always starts from the default branch of the Git repository, so that the branches of your Reltio tenants share history. This shared history lets you open pull requests between the branches.
-
- In the business configuration tree of the Reltio IDE extension view, right-click the Reltio tenant that is connected to Git and select Disconnect from Git.
The integrated development experience removes the local Git repository of the Reltio tenant and its history. Your files stay as they are, and commits that you have not pushed are lost. Your remote Git repository is not affected.
Figure 3. Disconnect from Git
Verification steps
To confirm the connection, check that the branch name appears next to the tenant name in the business configuration tree. To confirm the disconnection, check that the branch name no longer appears.
To prepare and promote changes, see Work with branches and promote changes between tenants. If the connection fails, see Troubleshoot Git repository.