Project, Version, and Code Location Naming

The project and version names of the project to which Detect writes results are, by default, derived from the project on which Detect is run. The mechanism Detect uses to determine the project and version names depends on project type. If Detect cannot determine the project and version names, then Detect uses the project directory name as the project name, and the value "Default Detect Version" as the version name.

You can use the following properties to override the project and version names:

--detect.project.name=PROJECT-NAME
--detect.project.version.name=VERSION-NAME

If no package manager provides project and version names, you have not provided the project and version names through properties, and the project uses Git, Detect] attempts to use Git to determine project information.

Project information is extracted from the remote URL for the current branch. The version is the current branch name, or the commit hash if a detached head is checked out. This is done by the Git detector. If you don't want Detect to use Git data, omit the Git detector using the following property:

--detect.excluded.detector.types=GIT

For example, for a project with a remote URL of "https://github.com/blackducksoftware/blackduck-detect" and a checked-out branch of "9.10.0", Detect] by default uses the project name "blackducksoftware/blackduck-detect" and project version "9.10.0".

Detect] attempts to derive project and version information by running the Git executable. If that is not successful, it attempts to derive project and version information by parsing Git files.

The Detect property for providing the path to the Git executable: detect.git.path.

Detect often generates multiple code locations (scans) in a single run. Each code location name consists of a base name and a type suffix that indicates what type of scan generated it.

You can modify the base name by adding a prefix and/or a suffix to the default base name using the detect.project.codelocation.prefix and detect.project.codelocation.suffix properties.

You also have the option to set the base name using the detect.code.location.name property. When detect.code.location.name is set, detect.project.codelocation.prefix and detect.project.codelocation.suffix are ignored.