Projects and Repositories
Embold organises repositories into projects. One repository can be linked to multiple projects at the same time.
Embold accepts following repository standards:
- *Apache Subversion (SVN)
*Currently only supported on Embold Version 1. Coming soon on Version 2( V2)
Create a project
Steps to create a project on Embold :
Navigate to the Projects page.
- Click Create A New Project button or New Project tile.
- Fill the project name and description in Create New Project pop-up and click Create Project button.
- Your new project will be now listed under projects. You may continue to link repositories to your new project.
Delete a repository from a project
Steps to delete a repository from your project:
- Inside your project, click on a repository and three dots on the top right corner. Click on the Delete repository permanently button.
- A warning message will appear to the user for the confirmation of deleting the repository.
- 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.
Get Repository UID
Steps to get repository UID from repository dashboard
- Inside your project, click on a repository and three dots on the top right corner. Click on the More Information button.
- From the Repository Information pop-up, copy that Repository UID and paste it appropriately while filling repository details on the server.
Version control account
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:
- Navigate to Admin section on left-side navigation pane and click the Version Control tab under Administration.
- 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.
- Mention your Host Type. There will be 2 host types: Cloud and On-premise.
- 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.
- Enter your desired Account Name.
- 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.
- 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.
Download Repository Report
Below are the steps to download the repository report:
- Go to Projects > Repositories. When user clicks on the respective repository, the Repository dashboard will be displayed.
- Click on the “Download Repository Report” icon.
- “Download Reports” pop-up window will be displayed to the user.
|Report||Type of issues||Format||Description||Example|
|Download Repository Report||--||This reports contains overall statistics of the repository.|
|MISRA Reports||code issues||PDF|
|Compliance Report: This report contains statistics, details of scan summary, issue name, graphical representation of violations and so on that are tagged against MISRA.|
MISRA Report: This report contains the information about the issue details that are tagged against MISRA.
|MISRA CPP:2008 compliance report
MISRA CPP:2008 report
|Code and Design Reports||code issues, design issues||CSV||This report contains the information about the issue details.||anti-pattern report|
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 can be used to promote the health of your repository on external websites like GitHub and Bitbucket.
Currently, Embold supports two badges:
- Rating – This badge shows the Overall Rating of your repository . Know more about Embold ratings here.
- 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.
Below are the sample values displayed as an example:
## Embold: Quality Gate
Check out badges-related API documentation here.