Commit sources
enable
your
external
repositories
to participate in traceability.
Commit
sources bring commit data into TeamForge for archival of metadata, participation in
traceability, and activity reporting.
Note: TeamForge Project SCM repositories are
added automatically as sources, both on upgrade and when new repositories are
defined in the TeamForge project context.
Create or find an existing Tool to group your commit source
under
-
From the desired project context, navigate to .
-
Determine whether a “Tool” exists that represents a logical container for your
desired source. For instance, if you are adding a source to represent an
external Git repository, look for a tool representing the Git server in
question.
-
If a Tool exists already, click the Tool’s title to edit the
Tool.
-
If a Tool does not exist, click Add Tool.
Edit an existing commit source
-
To edit an existing commit source, locate the Data Source in question on
the Edit Tool screen.
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
Important: 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.
-
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 commit source
-
If this is a new Tool, first select the Tool Type in the drop-down menu. For
instance, if you’re adding an external Git Tool instance, select
External Git.
-
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.
-
Provide a display name for the commit source. This display name will
help you differentiate the source throughout the user interfaces where
this source appears. The display name can be up to 100 alphanumeric
characters in length.
-
Select the repository type. Your source may be either a TeamForge
project repository or an "external" repository.
- Project repositories: repositories housed within
TeamForge projects
- External repositories: repositories housed outside of
TeamForge projects
Note: Sources for Project repositories are created automatically.You
need "Source Code view" permission to see available project
repositories.
-
For External repositories, enter your repository URL.
This is likely the URI used to check out code or a WebDAV-enabled
URL.
- For Subversion repositories: run the svn
info command inside the working copy and
copy/paste the value of the "URL" field.
- For Git repositories: run the git remote show
origin inside the working tree and use the value
of the "Fetch URL" field, without the "username@".
For example, if your Subversion repository URL is set to
https://forge.example.com/svn/repos/myproject,
TeamForge EventQ collects messages from the "myproject" repository
and all repositories under "myproject" such as
https://forge.example.com/svn/repos/myproject/branches/mybranch.
-
Click Update.
TeamForge saves the new commit source, and activates it.
Note: TeamForge EventQ
displays all the defined sources for a step in the order in which they were
defined.