Manage build source

Add build sources to bring automated build job results into the TeamForge project and traceability context.

Create or find an existing Tool to group your build source under

1. From the desired project context, navigate to Project Admin > Tools.
2. Determine whether a “Tool” exists that represents a logical container for your desired source. For instance, if you are adding a Jenkins source, look for a tool representing the instance of Jenkins in question.
   1. If a Tool exists already, click the Tool’s title to edit the Tool.
   2. If a Tool does not exist, click Add Tool.

Edit an existing build source

3. To edit an existing build source, find the Data Source in the list of sources associated with the tool. You can edit the display name or associate a different commit source for this build source. If you do not select a commit source, no associations will be drawn for the build activities coming from this build source. TeamForge displays a warning if a build source is not associated with a commit source. See Manage commit sources.
4. Click Update to save your changes.
   Note: While editing an existing source configuration, you can toggle a source from Active to Inactive, which will stop TeamForge from collecting data from that source; toggle back to Active to resume data collection from the source.

Create a new build source

5. If this is a new Tool, first select the Tool Type in the drop-down menu. For instance, if you’re adding a Jenkins Tool instance, select Jenkins.
6. Select the Include Traceability check box. A blank data source appears. If this is an existing Tool with existing sources, click the Data Source + (Add Source) icon to add a new blank source.
   1. Provide a display name for the build source. This display name will help you differentiate the source in lists throughout the user interfaces. The display name can be up to 100 alphanumeric characters in length.
   2. Select a commit source. Select the commit source from the list of existing commit sources (or create a new one).
      Important:

      • You must select a commit source from the list of existing commit sources to let TeamForge create associations between your build and commit activities.
      • If you do not select a commit source, no associations will be drawn for the build activities coming from this build source. TeamForge displays a warning if a build source is not associated with a commit source. See Manage commit sources for more information about adding a commit source.
      • For most source types, TeamForge generates a unique "source association key". The source association key uniquely identifies and helps route data from sources properly in TeamForge. 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.
7. Click Update.