Enabling External SCM Projects
To enable the external SCM feature in Codebeamer, the following line is to be added to the application configuration:
externalProviderScm : { enabled : true }
For more information, see Application configuration.
Application Configuration Options
The external SCM feature options have the following default values:
externalProviderScm : {
enabled : true,
repositorySynchronizationPeriodInSeconds : 3600,
synchronizationCyclePeriodInSeconds : 60,
fetchPageSize : 100,
jobDoneCommentEnabled : true
}
enabled : true,
repositorySynchronizationPeriodInSeconds : 3600,
synchronizationCyclePeriodInSeconds : 60,
fetchPageSize : 100,
jobDoneCommentEnabled : true
}
|
Parameter
|
Description
|
|---|---|
|
enabled
|
Enables or disables the synchronization.
|
|
repositorySynchronizationPeriodInSeconds
|
Determines whether the repository is considered fresh or ready to be updated. A repository synchronization starts if the repository has not been updated since the set time.
|
|
synchronizationCyclePeriodInSeconds
|
Marks the background synchronization process run period.
|
|
fetchPageSize
|
API fetch request and response size. The maximum value is 100.
|
|
jobDoneCommentEnabled
|
Enables or disables the background synchronization creating comments after run.
|
Access Tokens
For more information on GitHub access tokens, see GitHub Docs.
Only the repo segment needs to be selected.
To add an access token, do the following:
1. Copy and paste the token into the Token field of the new access token tracker item.
2. Click Save.
Add an External SCM Repository
An external SCM repository can be added either in the SCM Repositories tab of a project or in the SCM tracker. Before adding a new external repository, ensure that the feature is enabled in the application configuration.
To add a new repository in the SCM Repositories tab, do the following:
1. Go to the SCM Repositories tab of a project.
2. Click New External Repository.
3. Fill in the name of the repository and the access token. When a token already exists, skip this step and select the token in the next step.
4. Fill in the following information:
◦ Name: The name of the repository in Codebeamer (can be anything).
◦ Status: Enable or disable background synchronization, or show error state.
◦ Access token: Select the created access token.
◦ SCM Type: The provider of the SCM repository. Only GitHub is supported.
◦ Remote API url: Public or on-premise API URL. For GitHub URL, see https://api.github.com/.
◦ Owner name: The user name or organization name of the repository owner.
◦ Repository name: The name of the repository in GitHub.
◦ Enable patch synchronization: Enable or disable commit file change synchronization. The result is not shown on the user interface.
5. Click Save.
To add an external SCM repository in the SCM Repository tracker, do the following:
1. Go to the > >
2. Fill in the fields.
◦ Mandatory values:
▪ Status: Enable or disable background synchronization, or show error state.
▪ Access token: Select the created access token.
▪ SCM Type: The provider of the SCM repository. Only GitHub is supported.
▪ Remote API URL: Public or on-premise API URL. For GitHub URL, see https://api.github.com/.
▪ Owner name: The user name or organization name of the repository owner.
▪ Repository name: The name of the repository in GitHub.
▪ Enable patch synchronization: Enable or disable commit file change synchronization. The result is not shown on the user interface.
▪ Summary: The given name of the repository.
◦ Values to be added after synchronization:
▪ Base repository: Link to the base repository if it exists in the application. The repository is a fork.
▪ Remote id: The SCM internal remote id of the repository.
▪ Last synchronization date: The date of the last background synchronization.
▪ Html URL: Link to the repository page of the external provider.
▪ Default branch: Single mandatory branch for an external repository that can be viewed in the branch section.
▪ First commit hash: First, usually init, commit revision id of the repository.
▪ Fork: Shows whether a repository is considered to be a fork on the external provider.
3. Click [Save].
 | Only repositories with single default branches are supported, this means that the repositories must have root elements for all branches. |