How to connect MadCap Flare to Git

Use this instruction to connect MadCap Flare to GitHub.

Our goal is to connect your MadCap Flare project to a repository in GitHub or GitLab. After connecting your project to Git, you will be able to commit all your changes to Git and sync this repository with any MadCap Flare project.

Bind local MadCap project to GitHub

In this scenario, you have a local MadCap Flare project on your computer. You want to bind this project to the repository in GitHub. Binding means connecting, uploading, or syncing the local files with the remote repository in the GitHub web interface.

Connect MadCap project to GitHub repository

Bind using the Flare interface

To bind your MadCap Flare project to the GitHub repository:

  1. Create a new (empty) GitHub repository.

    New GitHub repository

  2. Copy the link to your new and empty repository.

    Copy the link to the repository

  3. In your MadCap Flare, open Project > Project Properties > Source Control > Bind Project.

    MadCap project properties

  4. Select Git as your source control provider.

  5. Select the Remote Repository checkbox.

  6. Select the Push on bind checkbox.

  7. Paste the link to your repository.

  8. Enter your name, email address, and click OK.

    Bind project

  9. Review the details of your bound project and click OK to close the menu.

    Bound project

Go to your GitHub repository and refresh the page to see the changes.

MadCap project repository changes

Your local project has been uploaded to your empty GitHub repository. Now you can change the local files in your MadCap project, commit the changes and push them to this remote repository.

Upload your Madcap project to GitHub using VS Code

You must have GitHub account and VS Code installed.

To connect your local MadCap project to a new GitHub repository in Visual Studio Code:

  1. Open your Flare project folder in VS Code.

    Open folder in VS Code

    Select folder

  2. Select the Source Control tab from the side panel or click Ctrl + Shift + G.

  3. Select Publish to GitHub.

    Publish to GitHub

  4. Select Publish to GitHub public repository and click OK.

    Publish to public repository

  5. Select Open on GitHub in the bottom left corner of the screen.

    Open on GitHub

You can go to your GitHub repositories and find your new repo.

GitHub repositories

Now, your local MadCap project is synced with this GitHub repository. You can use your VS Code to commit and push all your changes in this project.

Changes in VS Code

If you want to use Flare’s interface for Git operations, you need to bind it to a new repository as in Bind using the Flare interface.

Import an existing MadCap project from Git

To import an existing MadCap Flare project from the GitHub or GitLab repository:

  1. Go to the GitHub or GitLab repository containing the MadCap Flare project you want to import.

    For example:

  2. Copy the HTTPS link to this repository.

    For example:

    Copy link to the repository

  3. In MadCap Flare, select File > New Project > Import From Source Control.

    Import from Source Control

  4. Paste the HTTPS link to your GitHub or GitLab repository ending in .git and click Next.

    Select source control

  5. Click Browse, select the MadCap Flare project file in the remote repository, and click OK.

    Select project file

  6. Click Next and Finish.

    Finish importing

As a result, your MadCap project from GitHub or GitLab is imported locally on your computer. This MadCap project is now bound or connected to your remote repository. You can start changing the files locally, committing and pushing the changes to the remote repository.

Connect MadCap Flare project to Git

This is the video on YouTube where I show how to connect your local MadCap Flare project to the GitHub repository.

Last modified March 9, 2023: first commit (98b8333)