You are here: Features > Managing Your Project > Source Control > Binding a Project to Git

Binding a Project to Git

Use the following steps if you have already created a Flare project and want to bind ("connect") it to Git. You can also automatically detect existing source control bindings if your project has been previously connected to Git.

Closedhow to bind a project to source control
  1. Open the project.
  2. Select the Project ribbon. In the Properties section select Project Properties. The Project Properties dialog opens.
  3. Select the Source Control tab.
  4. Click Bind Project. The Bind Project dialog opens.

  5. From the drop-down, select Git.

  6. If you are going to bind to a remote repository, select the Remote Repository box, then enter the address of the repository in the field. If you want to work locally, you can leave this box unselected.

    Note: You may need to obtain this information from your system administrator.

    Note: If you use CloudForge Git as your remote repository, it may give you an incorrect URL. If you enter the incorrect URL in when binding your project, you will receive an error when you push or pull.

    To correct this error, change the URL from this format…

    https://username@madcapsoftware.git.cloudforge.com/yourproject.git

    …to this format…

    https://madcapsoftware.git.cloudforge.com/yourproject.git

    Removing the username@ section from the URL allows it to work properly when performing a push or pull.

  7. If you want to push to the remote repository when you bind the project, select the Push on bind check box. This will push the initial project files to the repository when you bind the project.
  8. In the Name field, enter your name.
  9. In the Email field, enter your email address.

  10. From the Save Per drop-down, select how you want to save your files.

    • User Saves the files in your local folder. Select this option if you are working with other tools (e.g., Tortoise) or if you want to use the same user identity across multiple projects.
    • Project Saves the files locally to your project. Select this option if you want to use different identities for each project.
  11. (Optional) In the Comment field, you can enter any internal comments that you would like.
  12. In the Bind Project dialog, click OK.
  13. In the Project Properties dialog, click OK.

  1. (Optional) If you entered an SSH URL in Step 6, the Certificate Specification dialog opens. In the dialog, do the following:

    1. In the Public key field, enter your public SSH key, or use to browse for the key on your network.
    2. In the Private key field, enter your private SSH key, or use to browse for the key on your network.
    3. If you want Flare to remember your key information so you do not need to enter it again later, select the check box next to Save certificate information.
Closedhow to Bind a Project to source control—Source Control Explorer
  1. Open the project.
  2. Select the View ribbon. In the Explorer section select Source Control Explorer. The Source Control Explorer opens.

  3. From the drop-down or the Home pane, select Settings. The Settings pane opens.

  4. Click Bind. The Bind Project dialog opens.

  5. From the drop-down, select Git.

  6. If you are going to bind to a remote repository, select the Remote Repository box, then enter the address of the repository in the field. If you want to work locally, you can leave this box unselected.

    Note: You may need to obtain this information from your system administrator.

  7. If you want to push to the remote repository when you bind the project, select the Push on bind check box. This will push the initial project files to the repository when you bind the project.
  8. In the Name field, enter your name.
  9. In the Email field, enter your email address.

  10. From the Save Per drop-down, select how you want to save your files.

    • User Saves the files in your local folder. Select this option if you are working with other tools (e.g., Tortoise) or if you want to use the same user identity across multiple projects.
    • Project Saves the files locally to your project. Select this option if you want to use different identities for each project.
  11. (Optional) In the Comment field, you can enter any internal comments that you would like.
  12. In the Bind Project dialog, click OK.
  13. In the Project Properties dialog, click OK.

  14. (Optional) If you entered an SSH URL in Step 62, the Certificate Specification dialog opens. In the dialog, do the following:

    1. In the Public key field, enter your public SSH key, or use to browse for the key on your network.
    2. In the Private key field, enter your private SSH key, or use to browse for the key on your network.
    3. If you want Flare to remember your key information so you do not need to enter it again later, select the check box next to Save certificate information.
ClosedAutomatically Detecting Existing Project Bindings

You can scan a project when you open it to see if it has any bindings to source control. If a binding is detected, you can apply the binding and commit the project to source control.

  1. Select File>Options. The Options dialog opens.
  2. Select the Source Control tab.
  3. Select the Bind Detection check box.

  4. Select the source control provider(s) you want to scan for bindings.

    Note: Source control providers are scanned in the following order:

    1. Git
    2. Subversion
    3. Perforce
    4. Microsoft Team Foundation Server (TFS)

    Microsoft Visual SourceSafe (VSS) and custom source control solutions are not supported.

Tip: Detecting source control bindings may take a considerable amount of time. It is recommended that you select only the source control providers that you use to speed up the detection process.

Closednote

Note: You can also bind a new Flare project to source control while creating it. See Creating a New Project.

Note: If you want to publish your output to source control, you must create a bind destination. See Creating Publishing Destinations.