FAQ on Scanning a Repository
Access
What type of access token is required when connecting to GitHub via the API?
You need to use a Personal Access Token, specifically the Classic Token. The Fine-Grained Token will not work because it does not grant the necessary permissions.
More details can be found under this section of the documentation.
What happens when we give access to read repositories during a scan?
If given access to read repositories, SD Elements will temporarily clone the specific branch of the selected repository. Once the scan is completed, canceled, or failed, the cloned repository is immediately deleted.
What are our options if we don’t have permissions to share our Git connections in SD Elements?
If users are reluctant to share Git connections through the UI or API, we have a long-term solution in development. This feature will enable self-hosting, allowing it to be utilized effectively within your own environment or CI/CD pipeline. You will be able to push data directly from your source into a specific SDE draft project.
Functionality
Can we perform bulk actions to scan multiple repositories into a single project?
No, currently we only allow one user to scan a repository to a given project at a time. Additional scans can be performed one at a time for the same project if it covers multiple repositories.
Can we conduct bulk actions where we can run scans simultaneously within different projects?
Yes, if a user creates an automated script via API, it can be configured to perform scans for a project without manual effort. Since only one scan can run at a time, a queue will be implemented to sequence through the scans configured to each project.
Is there any limit for the repository to scan size?
Yes, the maximum repository size is 2 Gb
Coverage
How can we find out what is currently covered by SD Elements mapping?
We have provided a separate table in the documentation that highlights the mappings we have built between repositories and the answers within an SD Elements Project.