Open RoboHelp.
Last updated on
17 May 2021
Learn how to collaborate from RoboHelp using GitHub.
Prerequisites for connecting to GitHub
- Install GitHub in your system. For detailed instructions, see the GitHub installation page.
- Add GitHub to system PATH.
- Set up GitHub in your system. For detailed instructions, see GitHub help.
Create a GitHub connection profile
To connect RoboHelp with GitHub, create a GitHub connection profile.
-
-
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 GitHub repository.
To create an SSH key, see GitHub help.
Note:While creating the SSH key, do not provide any paraphrase. There is a known issue with keys with password, which will be fixed in the next update.
After the SSH key is created and added, test your SSH connection. For more information, see GitHub 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 GitHub: Provide the path of the project you want to add to your GitHub repository for version control.
- Opening a connection: Provide the path to an empty local folder in which the GitHub project is to be cloned locally.
-
Click Save.
Add a RoboHelp project to GitHub
-
Open the project that you want to add to GitHub. This is the same project for which you specified the path while creating a GitHub connection. For more information, see Step 8 in Create a GitHub 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 GitHub repository, click Push.
Your RoboHelp project is added to your GitHub repository. You can start committing changes to and from the RoboHelp project to the GitHub repository.
-
To push your changes:
-
Make the required changes in your project.
-
Choose Collaborate > Commit.
-
Select the files to commit and provide a commit description.
-
Click Commit.
-
To push the changes to the GitHub repository, choose Collaborate > Push.
-
-
To sync changes from the GitHub 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:
- Choose Edit > Preferences > Version Control.
- Provide the path of the .exe file of any External Diff/Merge Application.
-
Choose Collaborate > Pull. The following message appears:
“Your local changes conflicted with changes made on the remote branch. Resolve the conflicts and commit to continue.” -
Choose Collaborate > Commit. This marks the conflicted files with Action as “In merge conflict” to indicate that there is a difference.
Then, to resolve conflicts, click
. -
Ensure that the merge application is already added. To add merge application, follow the steps in the Prerequisites.
-
Then, select the changes you want to commit and save the changes in the merge application. Close the merge application.
-
Select the file in the already open Commit dialog box and provide the commit description. Click Commit.
Then, click Push. GitHub repository changes and the local RoboHelp project is in sync now.
Open a RoboHelp project added to GitHub
-
Ensure that you have provided the correct path to the GitHub repository where your RoboHelp project is present and the local path points to an empty folder where the GitHub 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 GitHub 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 GitHub.
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online