Git Integration Section

The configuration parameters of this section can be used to set up integration with Git versioning systems. This integration can be used to save asset collections to an external Git repository and to restore them from there. It can also be used to update workspace projects, in particular those created from TopBraid Studio or external programs.

Power users or administrators can create multiple git repository connections here. Use the + button to create a new instance for each repository, then click on the new instance to edit the following properties:

Parameter

Description

Git repository URL

The URL of a Git repository. For GitHub these should look like https://github.com/MyCompany/MyProject.git

Git repository user name

The user name to authenticate to the git repository (e.g. for push requests). Typically combined with a password. Note that for GitHub access, the password may need to be a personal access token. See https://github.com/settings/tokens.

Git repository password

This field is editable only if the other Git parameters are set.

TopBraid user names

The names of the TopBraid users that have permission to access the repository. Only users that are listed AND have editor permissions on an asset collection can read/pull or write/push with the asset collections linked to the repository. Admins and Power Users have all permissions.

TopBraid project paths

The relative paths of folders in this git repo that shall be mapped to projects in the TopBraid workspace. Admins (NOT Power Users) can refresh those projects from the Modify menu. This is a good alternative to Project Upload.

The Modify Menu of the git configuration instances also offers various standard Git operations such as Pushing and Pulling.

Additional operations can be performed by JavaScript experts using the ADS framework, e.g. using the Script Editor Panel. The entry point into the Git API is IO.git.

See Also

Further Reading on TopBraid