Collaborate using Git

Open RoboHelp.

Choose Collaborate > New Connection.

In the Connection Profiles dialog box, specify a name for your connection profile.

From the Version Control drop-down list, select Git.

In the Repository SSH URL field, specify the repository SSH URL in the following format:

git@<servername>:<orgName/repoName>.git

In the Branch field, specify the branch name, for example, master.

In the SSH Private Key field, specify or navigate to the path of the SSH key that is linked to your Git repository.

To create an SSH key, see Git help. 

After the SSH key is created and added, test your SSH connection. For more information, see Git help.

A message confirming the successful addition of the SSH key appears at the lower-right corner of the screen.

In the Local Path field, specify the project path.

The project path must be different for each of the following scenarios:

• Adding a project to Git: Provide the path of the project you want to add to your Git repository for version control.
• Opening a connection: Provide the path to an empty local folder in which the Git project is to be cloned locally.

Click Save.

Open the project that you want to add to Git. This is the same project for which you specified the path while creating a Git connection. For more information, see Step 8 in Create a Git connection. 

Choose Collaborate > Add Project > <profile name>.

In the Commit dialog box, select the files that you want to add in the Git Version Control field.

In the Commit Description field, provide a description.

Click Commit.

To push the files to the Git repository, click Push.

Your RoboHelp project is added to your Git repository. You can start committing changes to and from the RoboHelp project to the Git repository.

To push your changes:

To sync changes from the Git repository to your local project, choose Collaborate > Pull.

After pushing files, if you receive the following message, it indicates a merge conflict in the files:

“The tip of your current branch is behind its remote counterpart. Try pulling before pushing.” 

To merge conflicts if the changes are made in the same file: 

Prerequisites:

1. Choose Edit > Preferences > Version Control. 
2. Provide the path of the .exe file of any External Diff/Merge Application.

Ensure that you have provided the correct path to the Git repository where your RoboHelp project is present and the local path points to an empty folder where the Git project will be cloned locally.

Open RoboHelp.

Choose Collaborate > Open Connection > <profile name>. The repository starts getting cloned in the local system.

Double-click the .rhpj file to open the project.

The Git project is now open.

You can start committing the changes with Push/Pull. To resolve conflicts, see Step 9 in Add a RoboHelp project to Git.