Creating Destination Files Using Source Control

How to Create a Destination File Using Source Control

1. Open the Project Organizer.
2. Open an existing destination file or add a new one. See Adding Destination Files.
3. In the Destination Editor, click in the Type drop-down field, and select Source Control.
4. In the Directory field, enter the folder where the output files will be published. You should enter a location that is not your project's output folder. This is because you do not want to inadvertently overwrite or delete your published files.
5. (Optional) You can the Comment field to provide a description of the destination so that its purpose is clear.

6. Complete the Source Control section.

   See the full topic for details.

   1. Create or detect a source control binding.

      If Your Project Is Already Bound to Source Control

      • Click Detect to search for existing source control bindings on the current destination folder. If they exist, Flare will automatically fill in the fields using this information.

        Note Source control providers are scanned in the following order:

        1. Git
        2. Subversion

        3. Perforce Helix Core

        4. Microsoft Team Foundation Server (TFS)

      • Click New to create a new bind destination. The Bind Destination dialog opens.

        To Set a Bind Destination—Git

        1. From the drop-down, select Git.

        2. If you are going to bind to a remote repository, select Remote Repository, then enter the address of the repository in the field. If you want to work locally, you can leave this box unselected. You can enter an HTTP URL or an SSH URL.

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

        3. 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.
        4. In the Name field, enter your name.
        5. In the Email field, enter your email address.

        6. 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.
        7. (Optional) In the Comment field, you can enter any internal comments.

        8. Click OK.

        9. (Optional) If you entered an HTTP address, enter your user name and password in the Log In dialog. Click OK when you are finished.

        10. (Optional) If you entered an SSH URL, the Certificate Specification dialog opens. In the dialog, do the following and click OK when you are finished:

            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.

        To Set a Bind Destination—Perforce Helix Core

        1. From the drop-down, select Perforce Helix Core.
        2. In the Server field, enter the server address.
        3. Next to the User field, click .
        4. Select a user and click OK. (Users are set up separately in Perforce Helix Core.)

        5. From the Type drop-down, select whether you want to bind to a stream or a depot. A depot contains multiple streams.

           If You are Binding to a Stream

           1. Next to the Stream field, click New.

              If the Log In dialog opens, complete the User name and Password fields and click OK.

              The New Stream dialog opens.

           2. From the Stream Type drop-down, select the type of stream you want to use. Most streams are mainline streams.

           3. Next to the Streams Depot field, click Browse.

              The Browse Depots dialog opens.

           4. Select a depot. This is essentially a folder or directory in Perforce Helix Core that contains multiple streams, one of which will be your Flare files.
           5. Click OK.
           6. (Optional) In the New Stream dialog, you can complete any of the other fields as necessary. For information about these fields, please refer to the documentation provided with Perforce Helix Core.
           7. Click OK.

           If You are Binding to a Depot

           1. Next to the Depot field, click New, or select an existing depot using the drop-down arrow.

              If you clicked New, the New Depot dialog opens.

           2. In the Name field, enter a name for the depot.
           3. (Optional) In the Description field, enter a description for the depot.
           4. Click OK.

           5. Next to the Path field, click .

              If the Log In dialog opens, complete the User name and Password fields and click OK.

              The Browse Source Control Folders dialog opens.

           6. Select the location where you want to bind the project.
           7. Click OK.
        6. (Optional) In the Comment field, you can enter any internal comments.
        7. (Optional) If you want the files in the project to be checked out when you are finished, click Keep files checked out.

        8. Click OK.

        To Set a Bind Destination—Subversion

        1. From the drop-down, select Subversion.
        2. In the Server field, enter the IP address.
        3. Next to the Destination Path field, click . The Browse Source Control Folders dialog opens.
        4. Click on the Subversion folder to which you want to bind the Flare project.
        5. Click OK.
        6. (Optional) In the Comment field, you can enter any internal comments.

        7. Click OK.

        To Set a Bind Destination—TFS

        1. From the drop-down, select Microsoft Team Foundation Server.

        2. In the Server field, enter the name of the computer or the IP address of the server. You can also click to select a "Team Project Collection." If you click this button, the Select Team Foundation Server Project Collection dialog opens, and you can do the following.

           1. To add a server, click . The Add Team Foundation Server dialog opens.
           2. Enter the name or URL of the server.
           3. Enter the path and port number.

           4. Select the protocol (HTTP or HTTPS).

           Note You may need to obtain this information from your system administrator. Click OK in the dialogs until you return to the main wizard page.

           Note Be sure to specify the path deeper than the server name. For example:

           .../tfs/DefaultCollection

           or

           .../tfs/SourceCollection

           If you do not know this information, contact your system administrator.

           Note If you run into issues in this dialog, chances are your user permissions do not have access to all of the collections on the TFS server. Please try to enter in the server/collection path manually.

        3. Next to the Destination Path field, click . The Browse Source Control Folders dialog opens.
        4. Click on the Team Foundation Server folder to which you want to bind the Flare project.
        5. Click OK.
        6. (Optional) In the Comment field, you can enter any internal comments.
        7. (Optional) If you want the files in the project to be checked out when you are finished, click Keep files checked out.

        8. Click OK.

        Note If your selected destination folder is already bound to source control and you are having difficulties with source control detection, you may need to unbind the destination folder using your source control tool and create a new source control destination.

      If Your Project Is Not Bound to Source Control

      • Click New to create a new source control binding. The Bind Destination dialog opens.

        To Set a Bind Destination—Git

        1. From the drop-down, select Git.

        2. If you are going to bind to a remote repository, select Remote Repository, then enter the address of the repository in the field. If you want to work locally, you can leave this box unselected. You can enter an HTTP URL or an SSH URL.

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

        3. 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.
        4. In the Name field, enter your name.
        5. In the Email field, enter your email address.

        6. 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.
        7. (Optional) In the Comment field, you can enter any internal comments.

        8. Click OK.

        9. (Optional) If you entered an HTTP address in Step ii, enter your user name and password in the Log In dialog and click OK when you are finished.

        10. (Optional) If you entered an SSH URL in Step ii, the Certificate Specification dialog opens. In the dialog, do the following and click OK when you are finished:

            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.

               Note SSH keys allow you to establish a secure connection between your computer and your Git source control provider (likewise, using an SSH URL is more secure than an HTTP URL; you need to use SSH keys if you want to use an SSH URL). If you do not have a public and private SSH key, your can generate these keys using your Git source control provider (e.g., Gitlab). Follow the directions provided by your source control provider to add these keys to your Git account. Once you generate these keys, they are typically found in the C:\Users\[username]\.ssh folder on your computer.

               Public keys typically have a .pub extension. Private keys use the same file name as the public key, but without the file extension.

               Example Use the following as guides when setting up your URLs and keys.

               SSH URL

               Copy

               git@gitlabomnibus.mycompany.corp:MyUserName/myproject.git

               HTTP URL

               Copy

               http://gitlabomnibus.mycompany.corp/MyUserName/myproject.git

               SSH Private Key

               Copy

               mycompanySSHkey_id_rsa

               SSH Public Key

               Copy

               mycompanySSHkey_id_rsa.pub

        To Set a Bind Destination—Perforce Helix Core

        1. From the drop-down, select Perforce Helix Core.
        2. In the Server field, enter the server address.
        3. Next to the User field, click .
        4. Select a user and click OK. (Users are set up separately in Perforce Helix Core.)

        5. From the Type drop-down, select whether you want to bind to a stream or a depot. A depot contains multiple streams.

           If You are Binding to a Stream

           1. Next to the Stream field, click New.

              If the Log In dialog opens, complete the User name and Password fields and click OK.

              The New Stream dialog opens.

           2. From the Stream Type drop-down, select the type of stream you want to use. Most streams are mainline streams.

           3. Next to the Streams Depot field, click Browse.

              The Browse Depots dialog opens.

           4. Select a depot. This is essentially a folder or directory in Perforce Helix Core that contains multiple streams, one of which will be your Flare files.
           5. Click OK.
           6. (Optional) In the New Stream dialog, you can complete any of the other fields as necessary. For information about these fields, please refer to the documentation provided with Perforce Helix Core.
           7. Click OK.

           If You are Binding to a Depot

           1. Next to the Depot field, click New, or select an existing depot using the drop-down arrow.

              If you clicked New, the New Depot dialog opens.

           2. In the Name field, enter a name for the depot.
           3. (Optional) In the Description field, enter a description for the depot.
           4. Click OK.

           5. Next to the Path field, click .

              If the Log In dialog opens, complete the User name and Password fields and click OK.

              The Browse Source Control Folders dialog opens.

           6. Select the location where you want to bind the project.
           7. Click OK.
        6. (Optional) In the Comment field, you can enter any internal comments.
        7. (Optional) If you want the files in the project to be checked out when you are finished, click Keep files checked out.

        8. Click OK.

        To Set a Bind Destination—Subversion

        1. From the drop-down, select Subversion.
        2. In the Server field, enter the IP address.
        3. Next to the Destination Path field, click . The Browse Source Control Folders dialog opens.
        4. Click on the Subversion folder to which you want to bind the Flare project.
        5. Click OK.
        6. (Optional) In the Comment field, you can enter any internal comments.

        7. Click OK.

        To Set a Bind Destination—TFS

        1. From the drop-down, select Microsoft Team Foundation Server.

        2. In the Server field, enter the name of the computer or the IP address of the server. You can also click to select a "Team Project Collection." If you click this button, the Select Team Foundation Server Project Collection dialog opens, and you can do the following.

           1. To add a server, click . The Add Team Foundation Server dialog opens.
           2. Enter the name or URL of the server.
           3. Enter the path and port number.

           4. Select the protocol (HTTP or HTTPS).

           Note You may need to obtain this information from your system administrator. Click OK in the dialogs until you return to the main wizard page.

           Note Be sure to specify the path deeper than the server name. For example:

           .../tfs/DefaultCollection

           or

           .../tfs/SourceCollection

           If you do not know this information, contact your system administrator.

           Note If you run into issues in this dialog, chances are your user permissions do not have access to all of the collections on the TFS server. Please try to enter in the server/collection path manually.

        3. Next to the Destination Path field, click . The Browse Source Control Folders dialog opens.
        4. Click on the Team Foundation Server folder to which you want to bind the Flare project.
        5. Click OK.
        6. (Optional) In the Comment field, you can enter any internal comments.
        7. (Optional) If you want the files in the project to be checked out when you are finished, click Keep files checked out.

        8. Click OK.

        Note If your selected destination folder is already bound to source control and you are having difficulties with source control detection, you may need to unbind the destination folder using your source control tool and create a new source control destination.

   2. Review your source control settings.

      • Provider Type This is the source control provider.

      • Database This is the current source control database.
      • Database Root This is the root folder in the source control database where source control files will be published.
      • Push to Remote (Git) Select this check box if you want to publish your output to a remote repository.

      • Remote Repository (Git) Select a remote repository from the drop-down. If you need to add or remove a remote repository, click to open the Remote Repositories dialog.

        To Add a Remote Repository

        1. In the Remote Repository field, enter the address of the new repository.

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

        2. In the Alias field, enter a name for the new repository. This is the name that will appear in the Remote drop-down when you need to select a remote repository.

           

           Note Repository names cannot include spaces.

        3. Click Add to add the new repository to the list of available repositories.

           

        4. Click OK.

        To Remove a Remote Repository

        1. From the Remote Repository list, select the repository you want to delete.
        2. Click Remove. The repository is removed from the list of available repositories.

        3. Click OK.

7. Select Login Credentials and enter the user name and password required for accessing the server to which you are publishing. This field is enabled only after you enter the host name.

   Note Login credentials are enabled after binding. If you are using Git, they are enabled if you selected the Push to Remote option.

8. (Optional) In the View URL field, you can enter an address corresponding to your publish destination. This field is for your own internal purposes, and is simply a quick way for you to open the output associated with the destination by clicking the button to the right.

9. (Optional) You can select the upload options.

   • Upload Only Changed Files Select this option if you want Flare to republish only the files that have changed. This can save significant time.
   • Remove Outdated Published Files Select this option if you want Flare to identify files that were previously published to the destination but are no longer in the source files. Flare will then remove such files from the destination.
10. Click to save your work.