Manage commit sources

Commit sources enables your TeamForge Project and external repos to participate in traceability.

1. From the activity stream, click Manage Sources.
2. Select the Commit toggle. TeamForge Orchestrate displays all existing "commit" sources.

You can choose to edit an existing source, or create a new commit source.

3. To edit an existing commit source, click Edit. You can edit the display name for any commit source. Commit sources can be defined with one of two repository types:
   • Project repositories: housed within TeamForge projects
   • External repositories: housed outside of TeamForge projects

   Once defined, you cannot switch the repository type. For external repositories, you can edit the repository URL. For project repositories, "Source Code view" permission is required and once selected and saved to a source, the project repository selection may not be altered. To work around this constraint, create a new source with a new repository and deactivate the old source.

   Note: While editing an existing source configuration, you can click DEACTIVATE to stop TeamForge Orchestrate from collecting data from that source; click ACTIVATE to resume data collection from the source.
4. To add a new commit source, click Add a new source.
   1. Provide a display name for the commit source that will be depicted on all screens in the TeamForge Orchestrate user interface where this source appears. The display name can be up to 100 alphanumeric characters.
   2. Select the repository type. Your source may be either a TeamForge project repository or an "external" repository.
      • Project repositories: housed within TeamForge projects; and
      • External repositories: housed outside of TeamForge projects.
      Note: You need "Source Code view" permission to see available project repositories.
   3. Enter repository information depending on your repository type:
      • TeamForge project repository — Select your repository from the list of project repositories that are not associated with any commit source. Only Subversion and Git repositories are supported. When you choose the repository, the repository URL is automatically populated. Requires "Source Code view" permission.
      • External repository — Enter your repository URL; this is likely the URI used to check-out code or a WebDAV-enabled URL. For Subversion repos, run the "svn info" command inside the working copy and copy/paste the value of the "URL" field. For Git repos, run "git remote show origin" inside the working tree and use the value of the "Fetch URL" field, without the "username@".
      Note: If your Subversion repository URL is set to: https://forge.example.com/svn/repos/myproject, TeamForge Orchestrate will collect messages from the "myproject" repository and all repositories under "myproject" such as https://forge.example.com/svn/repos/myproject/branches/mybranch
5. Click Done.

   TeamForge Orchestrate saves the new commit source, and activates it.

   For most source types, TeamForge Orchestrate generates a unique "source association key". The source association key uniquely identifies and helps route data from sources properly in TeamForge Orchestrate. You must supply this string while configuring adapters for most source types. You can copy the key by clicking on the small clipboard icon. No association key is necessary when you configure a TeamForge project code repository, though.

   Note: TeamForge Orchestrate displays all the defined sources for a step in the order in which they were defined.