Source Code Management (Git) Systems Integration
- Natallia_Mendzel@epam.com
- Anastasia Baranouskaya
- Aliaksei Apet
Metrics calculated by GIT data
Having configured GIT the following metrics will be available:
Select data source
1. On the main menu, click Perf, and then open the required unit.
2. On the right of the toolbar, click the Configure Data Sources icon. The Data Sources Configuration Step 1. Choose Data Source opens.
3. On the Step 1. Choose Data Source select your data source.
PERF application supports several services for GIT hosting server:
Azure Repos GIT;
BitBucket;
BitBucket Server (Stash);
GitHub;
GitLab.
4. On the Step 2. Configure Source set data source configuration.
1. Configure credentials
Configure Git Lab
Provide API URL. API url is usually the same as the web url. Details of the api are at https://docs.gitlab.com/ee/api/;
Provide Instance URL;
Connect by:
Login & Password, or
API Token (https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html);
Click Connect.
On how to obtain Access Tokens please refer to https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html.
Minimum required scopes for Personal Access Tokens: GitLab: read_api, read_repository
If you use https://git.epam.com/ for successful repository name validation also need to provide to user auto_epm-dce_perf-vcs@epam.com permissions on your project (Reporter will be enough)
Configure Git Hub
Provide API URL. API url usually differs from the web url you see in your web browser. For GitHub cloud the API url is https://api.github.com (more information here), for GitHub Enterprise the API url is
http(s)://[hostname]/api/v3/(more information here);Provide Instance URL. GitHub instance URL ishttps://github.com.
Specify Username;
Enter API Token;
Click Connect.
On how to obtain Access Tokens please refer to https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/.
Minimum required scopes for Personal Access Tokens: GitHub: repo, read:org
Please pay attention that you might also be asked to authorize the token by clicking Authorize
Configure Bitbucket (cloud)
Provide API URL. API url is https://api.bitbucket.org, Web url is https://bitbucket.org;
Provide Instance URL;
Specify Workspace ID;
Enter Login (Bitbucket username) & Password (about app passwords: https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/);
Click Connect.
Workspace ID is necessary to get access to repositories available for a particular team. Workspace ID can be found in Workspace settings in BitBucket. About Workspace settings: https://support.atlassian.com/bitbucket-cloud/docs/create-your-workspace/.
Configure Bitbucket Server (Stash)
Provide API URL;
Provide Instance URL;
Specify Project;
Connect by:
Login (Bitbucket username) & Password, or
API Token;
Click Connect.
Project is necessary to get access to repositories available for a particular team. Project can be found in Project settings in BitBucket. More information about Project settings: https://confluence.atlassian.com/bitbucketserver/creating-projects-776639848.html.
On how to obtain Access Tokens please refer to https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html.
Configure Azure Repos
Provide API URL. API URL has to contain an organization name. Ex.: https://dev.azure.com/myorganization.
Provide Instance URL;
Specify Project;
Connect by:
Login & Password, or
API Token;
Click Connect.
On how to obtain Access Tokens please refer to https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page.
GITLab | GITHub |
|---|---|
 |  |
Bitbucket | Azure Repos |
Bitbucket (cloud)  Bitbucket Server (Stash)  |  |
2. Configure Repositories and Branches
Open the Repositories/Branches step.
Select the required repository (you can use the Search function).
To add another repository, click on "Add Repository +"
For the added repository, select the necessary branches using the search feature.
To select all availble branches, click 3-dots button and select “All Brunches”
Selecting "All available branches" means that PERF will load all branches that are available for this repository at the time of data load. However, please be aware that this may affect the data load time.
Please note that there is a limit of no more than 300 branches allowed.
Cleck Next.
4. Configure advanced settings
The configuration of the Advanced settings is optional. The advanced settings are as follows:
Optional Action | Metric Affected |
|---|---|
Select the Include merge requests into statistics checkbox | |
In the Files to Exclude box, enter file wildcards to exclude files with the defined extensions |
Rules for File Excluding
PERF application uses Ant Path Matcher to exclude files from metrics.
5. Complete configuration process
To complete GIT configuration:
Click Save. The Run Data Load button appears.
Click Run Data Load to start data loading from GIT.