Appendix A: Repository Connectors

Existing sources

Description

This repository connector retrieves sources from a folder containing existing sources coming from a "Source Code Management" tool. It will automatically detect the SCM repository configuration to allow viewing the project source code downloaded from the remote repository.

Only Git, Subversion and Mercurial are currently supported. If credentials are needed, check the corresponding repository connector option.

As source code files are retrieved from the SCM remote repository when visualized, make sure that the analyzed directory does not contain any untracked or modified source code files, nor any local commits. Otherwise, these files will either not be displayed or be displayed with incoherent content with regard to the analysis.

Usage

Existing sources has the following options:

  • Input folder (path, mandatory): Specify the absolute path to the folder containing the existing sources you want to include in the analysis. When running the analysis on server side, the path must be accessible from the server.

  • This repository requires credentials when viewing source code after build (askCredentials, default: true): If you enable this option, users will need to specify credentials or a token to view source code.

    Note that the checkbox will be automatically unchecked, after the build, if no SCM has been detected.

The full command line syntax for Existing sources is:

-r "type=scm_auto,path=[directory],askCredentials=[booleanChoice]"