Work with branches and promote changes between Reltio tenants

Learn how to create and switch branches, commit and push changes, and promote a change from one Reltio tenant to another in the integrated development experience.

Work on a branch to prepare a change without affecting the configuration that other users use. In the integrated development experience, you create a branch or switch the branch of a Reltio tenant, and you commit and push your changes in the Source Control view. To promote a change to another Reltio tenant, you merge the branches on your Git host, and then you apply the configuration to that Reltio tenant.

The following roles can work with branches and promote changes:

Prerequisites

Before you begin, confirm the following requirements:

A Reltio tenant that you connected to Git.
Write access to the remote Git repository, so that you can push changes.
To promote a change from one Reltio tenant to another, both Reltio tenants are connected to Git, each to its own branch of the same Git repository.

To create a feature branch

In the business configuration tree of the Reltio IDE extension view, right-click the Reltio tenant and select Connect to a New Branch.
Select Create a new branch….

The description of the option shows the branch that you are on, for example branch off "dev", keeping your changes.

Figure 1. Branch list for the Connect to a New Branch option
Enter a name for the branch, for example feature/add-match-rule, and press Enter.
The integrated development experience creates a new branch from the Reltio tenant's current branch, keeps your uncommitted changes, and publishes the new branch to your remote Git repository. The Reltio tenant switches to the new branch, and the business configuration tree shows the new branch name next to the Reltio tenant.

To switch to another branch

If the Reltio tenant has uncommitted changes, commit or stash them.

The switch replaces the files in the tenant folder with the files of the other branch. The integrated development experience does not switch while the Reltio tenant has uncommitted changes, and it shows a message that tells you to commit or stash them first.
In the business configuration tree of the Reltio IDE extension view, right-click the Reltio tenant and select Connect to a New Branch.

This option opens the list of branches. You use it to switch to an existing branch and to create a branch.
Select the branch from the list.
The business configuration tree shows the new branch name next to the Reltio tenant.

To commit and push your changes

Open the Source Control view.

The view lists the configuration files that have changes.
Stage the changes, enter a message that states what changed and why, and then commit.
Select Sync Changes to push the commit to your remote Git repository.
If your team reviews changes in pull requests, open a pull request for the branch on your Git host.

To promote a change to another Reltio tenant

On the source Reltio tenant, create a feature branch.

The source Reltio tenant is where you develop and test the change. The target Reltio tenant is the one that receives it.
Make the change, apply it to the source Reltio tenant, and test it there.

To apply the change, right-click the Reltio tenant and select Apply Configuration to Tenant.
Commit and push the change, and then merge the feature branch into the branch of the source Reltio tenant on your Git host.
On your Git host, merge the branch of the source Reltio tenant into the branch of the target Reltio tenant.
Apply the merged configuration to the target Reltio tenant. Do one of the following:
- To apply it from the integrated development experience, select Sync Changes in the Source Control view for the Git repository of the target Reltio tenant, to pull the merged configuration into the tenant folder. Then right-click the target Reltio tenant and select Apply Configuration to Tenant.
  
  Figure 2. Apply Configuration to Tenant option for the target tenant
- To apply it through your deployment pipeline, run the pipeline that your team set up in your Git host, for example with GitHub Actions, GitLab CI/CD, or Bitbucket Pipelines. You do not need to pull or apply in the integrated development experience.
To promote the change to another Reltio tenant, repeat the merge and apply steps with that Reltio tenant as the target.

Verification steps

After you create or switch a branch, check that its name appears next to the tenant name in the business configuration tree.
After you push, check that the commit appears on the branch in your Git host.
After you promote a change, check that the merge is complete and that the target Reltio tenant contains the change.

If a step fails, see Troubleshoot Git repository.

Unify and manage your data

Work with branches and promote changes between Reltio tenants

Footer