Projects & repositories

Embold organises repositories into projects. One repository can be linked to multiple projects at the same time.

Embold accepts following repository standards:

• *Git
• *Apache Subversion (SVN)
• GitHub
• Bitbucket
• *TFS

*Currently only supported on Embold Version 1. Coming soon on Version 2( V2)

Steps to create a project on Embold :

1. Navigate to the Projects page.
2. Click Create A New Project button or New Project tile.
3. Fill the project name and description in Create New Project pop-up and click Create Project button.
4. Your new project will be now listed under projects. You may continue to link repositories to your new project.

Steps to link a repository to your project:

1. Inside your project, click Link Repositories tile. You have to click Link Repositories button on the project tile, if there is no repositories linked to the project yet.
2. In the Link Repositories pop-up, under Link New tab, fill the form and click Link Repository button.
3. Alternatively you can choose to link previously linked (to other projects) repositories by selecting Previously Added tab

Steps to unlink a repository to your project:

1. Inside your project, click on a repository and three dots on the top right corner. Click on the Unlink repository from project button.
2. Warning message will appear to the user for the confirmation of unlinking the repository.
3. Hence, the repository will not be linked to the project.

Steps to delete a repository from your project:

1. Inside your project, click on a repository and three dots on the top right corner. Click on the Delete repository permanently button.
2. A warning message will appear to the user for the confirmation of deleting the repository.
3. Hence, the repository will be permanently deleted from all the linked projects and no longer visible to the user. Moreover, all the on-going scans will be aborted.

Steps to get repository UID from repository dashboard

1. Inside your project, click on a repository and three dots on the top right corner. Click on the More Information button.
2. From the Repository Information pop-up, copy that Repository UID and paste it appropriately while filling repository details on the server.

Pre-requisites :

• You should have SSH keys (Public key need to be added to GitHub or Bitbucket account)generated on the server where you have installed Embold
• The resulting public key should be added to the remote Git repository (GitHub or Bitbucket)
• Reference for Linux SSH: Documentation on generating SSH key
• Reference for Windows SSH: Documentation on generating SSH key

Steps to link a repository using Git SSH:

1. Open Link Repositories popup.
2. Select Git as a repository type.
3. Provide repository Git URL in URL field in correct format (eg: git@github.com:apache/maven.git)
4. Check Enable SSH option.
5. Provide RSA private key generated on the Embold server in SSH Key field. Make sure to copy the entire text!
6. Provide passphrase if any.
7. Type in a repository name of your choice in the Repository Name field.
8. Select the language for which you would like to scan.
9. Click Link Repository button to complete the linking.

Below are steps to generate SSH keys on a Linux machine:

1. Start the key generation program by typing “ssh-keygen -m PEM -t rsa -b 4096” in terminal
2. Enter the filename you want for the key.
3. Enter passphrase if required. (This is optional)

Prerequisite: Git Bash

To install Git: Download and initiate the Git installer.

Below are steps to generate ssh keys On the windows machine

• In Windows, press Start+R to launch the Run dialog.
• Type C:\Program Files\Git\bin\bash.exe and press Enter.
• mkdir keys: Create a directory with name as keys.
• cd keys: Move to that directory.
• Start the key generation program by typing “ssh-keygen -m PEM -t rsa -b 4096“.
• Enter the filename you want for the key.
• Enter passphrase if required it is optional.

NOTE: keys are generated in the path where you run the ssh-keygen command.

A version control account enables you to integrate your GitHub, Bitbucket, GitLab or Azure DevOps (merge requests) accounts for seamless access. For successful integration, Embold needs repository access in GitHub or account, projects, and repositories read access in Bitbucket or read repository and API access in GitLab.

Steps to create a version control account:

1. Navigate to Admin section on left-side navigation pane and click the Version Control tab under Administration.
2. Click New Version Control Account pop-up window, select your desired account type. There will be 4 account types: GitHub, Bitbucket, GitLab and Azure DevOps.
3. Mention your Host Type. There will be 2 host types: Cloud and On-premise.
4. If the host type is selected as ‘Cloud’, the URL will be auto-populated. If the host type is selected as ‘On-premise’, you will need to enter the URL manually.
5. Enter your desired Account Name.
6. Mention Personal access token. See how to create a GitHub access token. or an app password for Bitbucket or a GitLab access token or an Azure DevOps access token.
7. Click on the “Add” button. Your new version control account will be added to the list of version control accounts.
   In the future, you may directly link a repository from your selected account type to a project in Embold easily as described in this article.

Once you integrate your GitHub, GitLab, Bitbucket or Azure DevOps account with Embold using Version Control Accounts, you can quickly and easily link repositories to Embold projects from such accounts.

Steps to link a repository using version control account:

1. Inside your project, click Link Repositories tile. You have to click Link Repositories button on the project tile if there are no repositories linked to the project yet.
2. In the Link Repositories pop-up, under Link New tab, select your version control account as repository type.
3. Select desired repository from the listing and fill rest of the fields.
4. Click Link Repository button. Selected repository will get linked to the project.

Note: Don’t have a project yet? Learn how to create one here.

Below are the steps to download the repository report:

1. Go to Projects > Repositories. When user clicks on the respective repository, the Repository dashboard will be displayed.
2. Click on the “Download Repository Report” icon.
3. “Download Reports” pop-up window will be displayed to the user.

What are badges?

Badges are the uniform way of displaying the tags to the repository to ensure better quality code. A list of badges is included in the Readme.MD file of your repository. 

Building badges helps to improve the readability of the repository. They provide visual information that portrays different colors.

Embold Badges

Embold badges can be used to promote the health of your repository on external websites like GitHub and Bitbucket.

Currently, Embold supports two badges:

1. Rating – This badge shows the Overall Rating of your repository . Know more about Embold ratings here.
   
2. Quality Gate: This badge shows whether the repository has passed or failed the quality standards set by you. Know more about quality gate here.
   

How to add badges to your repository?

To see badges, add this command to the Readme.MD file in your repository.

![Embold](https://YOUR_DOMAIN/api/badges?repository_uid=REPOSITORYUID&type=rating&token=EMBOLD_ACCESS_TOKEN)

Read more information about generating repository uid and Embold Access Token.

Below are the sample values displayed as an example:

## Embold: Quality Gate
![Embold](http://189.59.79.970:4500/api/badges?type=qualityGate&token=eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTYyNjk0MzU3NjA3MCwiaWF0IjoxNjI2OTQzNTc2fQ.aI80WAMwXAHsIsd0dlbmqE9X3Ytc7BqYqb04-doZPNHFLLvKf0Fc5G1wLRU11YubjVr9svkBUh9ZOU_O3toBfg&repositoryUid=4c8569cb090c89a28ce35817e8fc8d14)

Check out badges-related API documentation here.