diff --git a/buildSrc/src/main/java/com/blackduck/integration/detect/docs/GenerateDocsTask.java b/buildSrc/src/main/java/com/blackduck/integration/detect/docs/GenerateDocsTask.java
index 66e724a9e5..b3a079fa19 100644
--- a/buildSrc/src/main/java/com/blackduck/integration/detect/docs/GenerateDocsTask.java
+++ b/buildSrc/src/main/java/com/blackduck/integration/detect/docs/GenerateDocsTask.java
@@ -65,10 +65,6 @@ public void generateDocs() throws IOException, TemplateException, IntegrationExc
FileUtils.deleteDirectory(outputDir);
troubleshootingDir.mkdirs();
- // Metadata that Zoomin needs
- FileUtils.copyFileToDirectory(new File(docsProjectDir, "custom.properties"), outputDir);
- FileUtils.copyFileToDirectory(new File(docsProjectDir, "classification.xml"), outputDir);
-
File templatesDir = new File(docsSrcMainResourcesDir, "templates");
TemplateProvider templateProvider = new TemplateProvider(templatesDir, docsProject.getVersion().toString());
@@ -80,8 +76,7 @@ public void generateDocs() throws IOException, TemplateException, IntegrationExc
FileUtils.copyDirectory(sourceMarkdownDir, outputDir);
createMarkdownFromFreemarker(templateProvider, troubleshootingDir, "exit-codes", new ExitCodePage(helpJson.getExitCodes()));
createMarkdownFromFreemarker(templateProvider, runningDir, "status-file", new DetectorStatusCodes(helpJson.getDetectorStatusCodes()));
- // Commenting out in 9.4 to manually create detectors table
- // handleDetectors(templateProvider, outputDir, helpJson);
+
handleProperties(templateProvider, outputDir, helpJson);
createFromFreemarker(templateProvider, "downloadlocations.ftl", new File(installDir, "downloadlocations.md"));
}
@@ -101,33 +96,6 @@ private void createFromFreemarker(TemplateProvider templateProvider, String temp
template.process(data, writer);
}
}
- // Commenting out in 9.4 to manually create detectors table
- /* private void handleDetectors(TemplateProvider templateProvider, File baseOutputDir, HelpJsonData helpJson) throws IOException, TemplateException {
- File outputDir = new File(baseOutputDir, "components");
- List detectorTypes = new ArrayList<>();
- helpJson.getDetectors().stream()
- .sorted(Comparator.comparing(HelpJsonDetectorRule::getDetectorType))
- .forEach(detectorRule -> {
- List entryPointsForRule = new ArrayList<>();
- detectorRule.getEntryPoints().forEach(entry -> {
- List detectables = entry.getDetectables().stream()
- .map(detectable -> new Detectable(
- detectable.getDetectableName(),
- detectable.getDetectableLanguage(),
- detectable.getDetectableForge(),
- detectable.getDetectableRequirementsMarkdown(),
- detectable.getDetectableAccuracy()
- ))
- .collect(Collectors.toList());
- DetectorEntryPoint entryPoint = new DetectorEntryPoint(entry.getName(), detectables);
- entryPointsForRule.add(entryPoint);
- });
- DetectorType detectorType = new DetectorType(detectorRule.getDetectorType(), entryPointsForRule);
- detectorTypes.add(detectorType);
- });
-
- createMarkdownFromFreemarker(templateProvider, outputDir, "detectors", new DetectorCascadePage(detectorTypes));
- } */
private String encodePropertyLocation(String propertyName) {
if (!propertyName.equals(propertyName.trim())) {
diff --git a/documentation/FluidTopicsControlFile.xml b/documentation/FluidTopicsControlFile.xml
new file mode 100644
index 0000000000..a9d143f50b
--- /dev/null
+++ b/documentation/FluidTopicsControlFile.xml
@@ -0,0 +1,21 @@
+
+
+
+
+ detect.ditamap
+ bd_detect-latest
+ bd_detect
+
+
+ detect
+
+
+ latest
+
+
+ access_all
+
+
+
+
+
diff --git a/documentation/classification.xml b/documentation/classification.xml
deleted file mode 100644
index df1b4b662e..0000000000
--- a/documentation/classification.xml
+++ /dev/null
@@ -1,82 +0,0 @@
-
-
-
-
- Black Duck
- Black Duck
- 2021-03-18T05:43:42Z
- 2021-03-26T01:40:29Z
- 16.00
-
-
-
-
-
- 7455
- 21570
- 32767
- 32767
- False
- False
-
-
-
-
-
-
-
-
-
-
-
-
- | Filename |
- Title |
- Product |
- Role |
- Document Type |
- Access |
-
-
- | MAP |
- detect |
- role_developer |
- doctype_userguide |
- access_all |
-
-
- | apply-ALL |
- detect |
- role_developer |
- doctype_userguide |
- access_all |
-
-
- | default |
-
-
-
-
-
-
-
-
-
-
- False
- False
-
-
-
diff --git a/documentation/custom.properties b/documentation/custom.properties
deleted file mode 100644
index d7cd7d36ef..0000000000
--- a/documentation/custom.properties
+++ /dev/null
@@ -1,3 +0,0 @@
-document.locale=enus
-args.input.path=detect.ditamap
-
diff --git a/documentation/keywords.ditamap b/documentation/keywords.ditamap
index 1ac7be62ed..c380c0a92e 100644
--- a/documentation/keywords.ditamap
+++ b/documentation/keywords.ditamap
@@ -18,8 +18,8 @@
Black Duck
Artifactory
blackduck-detect
- detect11.sh
- detect11.ps1
+ detect12.sh
+ detect12.ps1
Black Duck Signature Scanner
Black Duck signature scan
Black Duck Docker Inspector
diff --git a/documentation/scripts/checkSize.sh b/documentation/scripts/checkSize.sh
old mode 100755
new mode 100644
diff --git a/documentation/scripts/diff_doc.sh b/documentation/scripts/diff_doc.sh
old mode 100755
new mode 100644
diff --git a/documentation/scripts/findOrphans.sh b/documentation/scripts/findOrphans.sh
old mode 100755
new mode 100644
diff --git a/documentation/scripts/ftl2md.sh b/documentation/scripts/ftl2md.sh
old mode 100755
new mode 100644
diff --git a/documentation/src/main/markdown/configuring/commandline.md b/documentation/src/main/markdown/configuring/commandline.md
index 89aac2be50..2c248b2e83 100644
--- a/documentation/src/main/markdown/configuring/commandline.md
+++ b/documentation/src/main/markdown/configuring/commandline.md
@@ -12,5 +12,5 @@ There is a space before and between each complete property setting, but there ar
For example,
to set property *detect.project.name*:
```
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name=MyProject
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=MyProject
```
diff --git a/documentation/src/main/markdown/configuring/configfile.md b/documentation/src/main/markdown/configuring/configfile.md
index 40389e90a6..fba166ec6f 100644
--- a/documentation/src/main/markdown/configuring/configfile.md
+++ b/documentation/src/main/markdown/configuring/configfile.md
@@ -13,7 +13,7 @@ For example, if you wanted to set property *detect.project.name* using a configu
could do it as follows:
````
echo "detect.project.name=myproject" > application.properties
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.source.path=/opt/projects/project1
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.source.path=/opt/projects/project1
````
Because the configuration file has one of the file names that Spring looks for by default
(in this case, application.properties) and exists in one of the locations
diff --git a/documentation/src/main/markdown/configuring/envvars.md b/documentation/src/main/markdown/configuring/envvars.md
index 1febf5ac83..7d6cce8ee5 100644
--- a/documentation/src/main/markdown/configuring/envvars.md
+++ b/documentation/src/main/markdown/configuring/envvars.md
@@ -7,7 +7,7 @@ is the property name converted to uppercase, with period characters (".") conver
characters ("_"). For example:
```
export DETECT_PROJECT_NAME=MyProject
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh)
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh)
```
On Windows, the environment variable name can either be the original property
@@ -15,5 +15,5 @@ name, or the property name converted to uppercase with period characters (".") c
characters ("_"). For example:
```
$Env:DETECT_PROJECT_NAME = MyProject
-powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect"
+powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect"
```
diff --git a/documentation/src/main/markdown/configuring/profiles.md b/documentation/src/main/markdown/configuring/profiles.md
index deda7112d3..9300431161 100644
--- a/documentation/src/main/markdown/configuring/profiles.md
+++ b/documentation/src/main/markdown/configuring/profiles.md
@@ -14,7 +14,7 @@ Populate it with property assignments as previously described.
To select one or more profiles on the [detect_product_short] command line, assign the the comma-separated list of profiles
to the Spring Boot property *spring.profiles.active*:
```
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --spring.profiles.active={profilename}
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --spring.profiles.active={profilename}
```
This capability is provided by Spring Boot. For more information, refer to
diff --git a/documentation/src/main/markdown/currentreleasenotes.md b/documentation/src/main/markdown/currentreleasenotes.md
index a7fe930930..ffa1d1f609 100644
--- a/documentation/src/main/markdown/currentreleasenotes.md
+++ b/documentation/src/main/markdown/currentreleasenotes.md
@@ -2,11 +2,9 @@
**Notices**
-[company_name] [solution_name] has been renamed [detect_product_long] with page links, documentation, and other URLs updated accordingly. Update any [detect_product_short] documentation, or other bookmarks you may have. See the [Domain Change FAQ](https://community.blackduck.com/s/article/Black-Duck-Domain-Change-FAQ).
* Please make use of repo.blackduck.com and detect.blackduck.com for code downloads.
* [detect_product_short] script downloads should only be accessed via detect.blackduck.com.
* [detect_product_short] 10.0.0 and later will only work when using repo.blackduck.com.
- * If you are using [detect_product_short] 8 or 9 it is essential to update to 8.11.2 or 9.10.1 respectively.
* [bd_product_long] [SCA Scan Service (SCASS)](https://community.blackduck.com/s/question/0D5Uh00000O2ZSYKA3/black-duck-sca-new-ip-address-requirements-for-2025) requires customers add or update IP addresses configured in their network firewalls or allow lists. This action is required to successfully route scan data to the service for processing.
diff --git a/documentation/src/main/markdown/downloadingandinstalling/selfupdatingdetect.md b/documentation/src/main/markdown/downloadingandinstalling/selfupdatingdetect.md
index a67a7d080c..4bc3ba1f3c 100644
--- a/documentation/src/main/markdown/downloadingandinstalling/selfupdatingdetect.md
+++ b/documentation/src/main/markdown/downloadingandinstalling/selfupdatingdetect.md
@@ -7,7 +7,6 @@
The Self Update feature will call the `/api/tools/detect` API end point to check for the existence of a specified [detect_product_short] version in [bd_product_short] under the **Admin > System Settings > [detect_product_short] > [detect_product_short] Version** drop-down. If a version that is eligible for upgrade or downgrade has been specified, the request to download that version of the [detect_product_short] .jar will execute and the current run of [detect_product_short] will invoke it for the requested scan.
[detect_product_short] will download the required version from the repository when the service is hosted, or from a custom URL as configured in [bd_product_short], when internally hosted. To support self-update via internal hosting, the [detect_product_short] binary must be in a location accessible via https to all executing [detect_product_short] instances.
-Centralized [detect_product_short] Version Management feature support in [bd_product_short] is available from [bd_product_short] version 2023.4.0 onwards.
@@ -28,9 +27,7 @@ If the [detect_product_short] URL of the [detect_product_short] .jar file to dow
If the [bd_product_short] “Internally Hosted” option has been selected and a [detect_product_short] download location has not been provided, the feature will not be enabled.
-For further [bd_product_short] configuration information, refer to the documentation provided under the topic:
- Hosting location for [detect_product_short].
-
+For further [bd_product_short] configuration information, refer to the documentation provided under the topic: [Hosting location for Detect](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/hosting-location-for-black-duck-detect.html).
## [detect_product_short] log examples for self update
diff --git a/documentation/src/main/markdown/gettingstarted/overview.md b/documentation/src/main/markdown/gettingstarted/overview.md
index 21ab6de51f..8774c1d1a1 100644
--- a/documentation/src/main/markdown/gettingstarted/overview.md
+++ b/documentation/src/main/markdown/gettingstarted/overview.md
@@ -4,5 +4,5 @@ Before you start using [detect_product_short], it is recommended that you become
For a quick tutorial see: [Introduction to Scanning](https://community.blackduck.com/s/article/Black-Duck-Introduction-to-Scanning).
-[detect_product_short] documentation is incremental in nature with new functionality and changes indentified in the [Release notes](../currentreleasenotes.md) and [Properties](../properties/all-properties.md). However, documentation is also available for previous [detect_product_short] versions by navigating to the documentation portal [linked here](https://documentation.blackduck.com/bundle) and clicking on the **Archived** button.
+[detect_product_short] documentation is incremental in nature with new functionality and changes indentified in the [Release notes](../currentreleasenotes.md) and [Properties](../properties/all-properties.md). However, documentation is also available for previous [detect_product_short] versions by navigating to the documentation portal [linked here](https://docs.blackduck.com) and selecting one of the hosted document versions from the drop-down when viewing [detect_product_short] documentation.
diff --git a/documentation/src/main/markdown/gettingstarted/quickstart.md b/documentation/src/main/markdown/gettingstarted/quickstart.md
index 4348a8afc9..c1bf64b332 100644
--- a/documentation/src/main/markdown/gettingstarted/quickstart.md
+++ b/documentation/src/main/markdown/gettingstarted/quickstart.md
@@ -54,7 +54,7 @@ In the junit4 case, [detect_product_short] will:
Once the scan is complete, navigate with your browser to the [bd_product_short] Project BOM URL to see the Bill Of Materials for junit4.
-For guidance on getting started using, and viewing results in [bd_product_short], check out [Getting Started with Black Duck SCA](https://documentation.blackduck.com/bundle/bd-hub/page/Administration/Hub101.html)
+For guidance on getting started using, and viewing results in [bd_product_short], check out [Getting Started with Black Duck SCA](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/getting-started-with-black-duck-sca.html)
## Next steps
diff --git a/documentation/src/main/markdown/gettingstarted/requirements.md b/documentation/src/main/markdown/gettingstarted/requirements.md
index 28e05348c1..21bb43ddb8 100644
--- a/documentation/src/main/markdown/gettingstarted/requirements.md
+++ b/documentation/src/main/markdown/gettingstarted/requirements.md
@@ -41,7 +41,7 @@
* Licensed installation of the current version of [bd_product_short] with access credentials.
Visit the [Black Duck release page](https://github.com/blackducksoftware/hub/releases) to determine the current version of [bd_product_short].
-* For information regarding compatible versions of [bd_product_short], consult the [bd_product_short] [Release Compatibility page](https://documentation.blackduck.com/bundle/blackduck-compatibility/page/topics/Black-Duck-Release-Compatibility.html)
+* For information regarding compatible versions of [bd_product_short], consult the [bd_product_short] [Release Compatibility page](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/black-duck-sca-release-compatibility.html)
* The [bd_product_short] notifications module must be enabled.
* A [bd_product_short] user with the [required roles](usersandroles.md).
* On Alpine Linux you will also need to override the Java installation used by the [blackduck_signature_scanner_name] as
@@ -66,5 +66,4 @@ The risk report requires that the following fonts are installed:
## Supported [detect_product_short] versions and Service duration
-For information about support and service durations for [detect_product_short] versions, consult the
- Support and Service Schedule.
+For information about support and service durations for [detect_product_short] versions, consult the [Support and Service Schedule](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/product-maintenance-support-and-service-schedule.html).
diff --git a/documentation/src/main/markdown/gettingstarted/terms/properties.md b/documentation/src/main/markdown/gettingstarted/terms/properties.md
index 145fce28e6..83d2320d07 100644
--- a/documentation/src/main/markdown/gettingstarted/terms/properties.md
+++ b/documentation/src/main/markdown/gettingstarted/terms/properties.md
@@ -5,13 +5,13 @@ Properties in [detect_product_long] provide information used to determine how an
When setting a property value, the property name is prefixed with two hyphens (--).
````
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) <--property=value>
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) <--property=value>
````
Example using properties to specify project name and [bd_product_short] URL:
````
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name=MyProject --blackduck.url=https://blackduck.yourdomain.com
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=MyProject --blackduck.url=https://blackduck.yourdomain.com
````
When configuring [detect_product_short] via environment variables or configuration file, specific property handling applies. See [Using environment variables](../../configuring/envvars.md) or [Using a configuration file](../../configuring/configfile.md).
diff --git a/documentation/src/main/markdown/gettingstarted/usersandroles.md b/documentation/src/main/markdown/gettingstarted/usersandroles.md
index eab64d8edf..4ce7c1c612 100644
--- a/documentation/src/main/markdown/gettingstarted/usersandroles.md
+++ b/documentation/src/main/markdown/gettingstarted/usersandroles.md
@@ -2,9 +2,7 @@
Any user can download [detect_product_short] and run a scan, however you must configure a user/API token in [bd_product_short] for the [detect_product_short] scan to be analyzed by [bd_product_short].
-For more information on creating a [bd_product_short] user token, please consult the documentation provided by [bd_product_short] under the topic:
- Managing user access tokens.
-
+For more information on creating a [bd_product_short] user token, please consult the documentation provided by [bd_product_short] under the topic: [Managing user access tokens](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/managing-user-access-tokens.html).
**The following user roles are required for the user that you create in [bd_product_short]**
diff --git a/documentation/src/main/markdown/integrations/acr/azurecontainerregistry.md b/documentation/src/main/markdown/integrations/acr/azurecontainerregistry.md
index d9cac9bcba..592727da3a 100644
--- a/documentation/src/main/markdown/integrations/acr/azurecontainerregistry.md
+++ b/documentation/src/main/markdown/integrations/acr/azurecontainerregistry.md
@@ -42,7 +42,7 @@ The *az acr login* command generates an authentication token and authenticates w
**[detect_product_short] - Scanning Images**
```
-bash <(curl -s -L https: //detect.blackduck.com/detect11.sh) \
+bash <(curl -s -L https: //detect.blackduck.com/detect12.sh) \
--blackduck.url= \
--blackduck.api.token= \
--detect.docker.image= \
@@ -95,7 +95,7 @@ Start in **Pipelines > Library** inside Azure DevOps.
#Log in to ACR using the configured Variable Group
docker login .azurecr.io -u $(acr.username) -p $(acr.password)
#Call Detect, passing the Docker Image location
-bash <(curl -s -L https: //detect.blackduck.com/detect11.sh) \
+bash <(curl -s -L https: //detect.blackduck.com/detect12.sh) \
--blackduck.url=$(blackduck.url) \
--blackduck.api.token=$(blackduck.api.token) \
--detect.docker.image=.azurecr.io/:$(Build.BuildId) \
diff --git a/documentation/src/main/markdown/integrations/azureplugin/azurepluginrequirements.md b/documentation/src/main/markdown/integrations/azureplugin/azurepluginrequirements.md
index 952f0898f2..d4b0a1fdd9 100644
--- a/documentation/src/main/markdown/integrations/azureplugin/azurepluginrequirements.md
+++ b/documentation/src/main/markdown/integrations/azureplugin/azurepluginrequirements.md
@@ -3,7 +3,7 @@
The following is a list of requirements for the [detect_product_long] in Azure DevOps integration.
* [bd_product_long] server.
- For the supported versions of [bd_product_short], refer to [Black Duck Release Compatibility](https://documentation.blackduck.com/bundle/blackduck-compatibility/page/topics/Black-Duck-Release-Compatibility.html).
+ For the supported versions of [bd_product_short], refer to [Black Duck Release Compatibility](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/black-duck-sca-release-compatibility.html).
* [bd_product_short] API token to use with Azure.
* Azure DevOps Services or Azure DevOps Server 17 or later
* Java.
diff --git a/documentation/src/main/markdown/integrations/bitbucket/bitbucketintegration.md b/documentation/src/main/markdown/integrations/bitbucket/bitbucketintegration.md
index 6811e52cb0..93838725e4 100644
--- a/documentation/src/main/markdown/integrations/bitbucket/bitbucketintegration.md
+++ b/documentation/src/main/markdown/integrations/bitbucket/bitbucketintegration.md
@@ -41,7 +41,7 @@ This section describes how to run [detect_product_short] with Bitbucket pipeline
3. Add the following snippet to the `bitbucket-pipelines.yml` file:
```
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --blackduck.url="${BLACKDUCK_URL}"
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --blackduck.url="${BLACKDUCK_URL}"
--blackduck.api.token="${BLACKDUCK_TOKEN}" --blackduck.trust.cert=true --
```
@@ -68,7 +68,7 @@ pipelines:
- step:
name: detect
script:
- - bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --blackduck.url="${BLACKDUCK_URL}" --blackduck.api.token="${BLACKDUCK_TOKEN} --blackduck.trust.cert=true"
+ - bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --blackduck.url="${BLACKDUCK_URL}" --blackduck.api.token="${BLACKDUCK_TOKEN} --blackduck.trust.cert=true"
```
Configure [detect_product_short] as a command after the code-build step as it relies on access to the code tree and the build environment.
diff --git a/documentation/src/main/markdown/integrations/gitlab/gitlabintegration.md b/documentation/src/main/markdown/integrations/gitlab/gitlabintegration.md
index ee6bda48f6..8fb9f97ef5 100644
--- a/documentation/src/main/markdown/integrations/gitlab/gitlabintegration.md
+++ b/documentation/src/main/markdown/integrations/gitlab/gitlabintegration.md
@@ -46,7 +46,7 @@ The recommended way of configuring [detect_product_short] from a GitLab pipeline
test:
stage: test
script:
- - bash <(curl -s -L https://detect.blackduck.com/detect9.sh) --blackduck.url="${BLACKDUCK\_URL}" --blackduck.api.token="${BLACKDUCK\_TOKEN}" --blackduck.trust.cert=true --
+ - bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --blackduck.url="${BLACKDUCK\_URL}" --blackduck.api.token="${BLACKDUCK\_TOKEN}" --blackduck.trust.cert=true --
```
5. Configure [detect_product_short] as a script build step so GitLab can enforce build changes influenced by [detect_product_short]. For example, checking for policy, failing builds according to policy, and others.
@@ -88,7 +88,7 @@ For improved security, it is recommended to use a revocable API token, as descri
test:
stage: test
script:
- - bash <(curl -s -L ) --blackduck.url="${BLACKDUCK\_URL}" --blackduck.hub.username="${BLACKDUCK\_USERNAME}" --blackduck.hub.password="${BLACKDUCK\_PASSWORD}" --blackduck.trust.cert=true --
+ - bash <(curl -s -L ) --blackduck.url="${BLACKDUCK\_URL}" --blackduck.hub.username="${BLACKDUCK\_USERNAME}" --blackduck.hub.password="${BLACKDUCK\_PASSWORD}" --blackduck.trust.cert=true --
```
5. Configure [detect_product_short] as a script build step so GitLab can enforce build changes influenced by [detect_product_short]. For example, checking for policy, failing builds according to policy, and others.
diff --git a/documentation/src/main/markdown/integrations/integrations.md b/documentation/src/main/markdown/integrations/integrations.md
index 79fafbc7ee..e74409a755 100644
--- a/documentation/src/main/markdown/integrations/integrations.md
+++ b/documentation/src/main/markdown/integrations/integrations.md
@@ -5,5 +5,5 @@ The [detect_product_short] integrations allow users to install and run [detect_p
[detect_product_short] scans code bases in your projects and folders to perform compositional analysis and functions as a [bd_product_short] intelligent scan client. [detect_product_short] sends scan results to [bd_product_short], which generates risk analysis when identifying open source components, licenses, and security vulnerabilities.
**Note:** Plugins are independant open source projects, not all will be supported for a particular release of [detect_product_short] at the time of [detect_product_short] release.
-Please consult the [compatibility matrix](https://documentation.blackduck.com/bundle/blackduck-compatibility/page/topics/Black-Duck-Release-Compatibility.html) to determine the compatible releases.
+Please consult the [compatibility matrix](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/black-duck-sca-release-compatibility.html) to determine the compatible releases.
diff --git a/documentation/src/main/markdown/naming/aggregation.md b/documentation/src/main/markdown/naming/aggregation.md
index 46ad913061..144c53064c 100644
--- a/documentation/src/main/markdown/naming/aggregation.md
+++ b/documentation/src/main/markdown/naming/aggregation.md
@@ -1,6 +1,6 @@
# BDIO aggregation
-Starting with version 8.0.0, [detect_product_short] aggregates all package manager results into a single BDIO file / codelocation.
+[detect_product_short] aggregates all package manager results into a single BDIO file / codelocation.
All dependency graphs produced by any of the following, executed during the [detect_product_short] run, will be aggregated:
@@ -8,9 +8,7 @@ All dependency graphs produced by any of the following, executed during the [det
* Docker Inspector
* Bazel
-This BDIO takes advantage of
-functionality added to [bd_product_short] in version 2021.8.0
-enabling [bd_product_short] to preserve both source information (indicating, for example, from which
+This BDIO takes advantage of [bd_product_short] functionality that enables [bd_product_short] to preserve both source information (indicating, for example, from which
subproject a dependency originated) and match type information (direct vs. transitive dependencies).
[detect_product_short] now operates in a way that is similar to [detect_product_short] 7
diff --git a/documentation/src/main/markdown/previousreleasenotes.md b/documentation/src/main/markdown/previousreleasenotes.md
index d3f7a64278..4bd919affc 100644
--- a/documentation/src/main/markdown/previousreleasenotes.md
+++ b/documentation/src/main/markdown/previousreleasenotes.md
@@ -236,7 +236,7 @@
### New features
-* SCA Scan Service (SCASS) is a scalable solution for performing software composition analysis scans outside of the traditional [bd_product_long] environment. This [detect_product_short] release provides support for SCA Scan Service (SCASS) package manager and signature scans when deployed with [bd_product_short] version 2025.7.0 or later. For further information see [About SCASS](https://documentation.blackduck.com/bundle/bd-hub/page/ComponentDiscovery/aboutScaScanService.html).
+* SCA Scan Service (SCASS) is a scalable solution for performing software composition analysis scans outside of the traditional [bd_product_long] environment. This [detect_product_short] release provides support for SCA Scan Service (SCASS) package manager and signature scans when deployed with [bd_product_short] version 2025.7.0 or later. For further information see [About SCASS](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/about-sca-scan-service.html).
* To learn more about the IP address configuration requirements for your deployments, refer to the IP notice above.
* A new property, [detect.stateless.policy.check.fail.on.severities](properties/basic-properties.html#ariaid-title34) has been added, which will trigger [detect_product_short] to fail the scan and notify the user if a policy violation matches the configured value. This property overrides the default "Blocker" and "Critical" severity settings that cause [detect_product_short] scans to exit. This property applies to both [Rapid](runningdetect/rapidscan.md) and [Stateless](runningdetect/statelessscan.md) scans. Intelligent persistent scans, (when scan mode is not set to RAPID, STATELESS, or [--detect.blackduck.scan.mode](properties/all-properties.html#ariaid-title5) is explicitly set to INTELLIGENT and scan data is persisted), should continue using the [detect.policy.check.fail.on.severities](properties/basic-properties.html#ariaid-title34), property.
@@ -328,7 +328,7 @@
### New features
* Added support for `ArtifactsPath` and `BaseIntermediateOutputPath` properties in [detect_product_long] NuGet Inspector. See [detect.nuget.artifacts.path](packagemgrs/nuget.md#nuget-artifacts-and-base-intermediate-output-paths) for more details.
-* SCA Scan Service (SCASS) is a scalable solution for performing software composition analysis scans outside of the traditional [bd_product_long] environment. This [detect_product_short] release provides support for the SCA Scan Service (SCASS) for [bd_product_short] version 2025.1.1 or later. For further information see [About SCASS](https://documentation.blackduck.com/bundle/bd-hub/page/ComponentDiscovery/aboutScaScanService.html).
+* SCA Scan Service (SCASS) is a scalable solution for performing software composition analysis scans outside of the traditional [bd_product_long] environment. This [detect_product_short] release provides support for the SCA Scan Service (SCASS) for [bd_product_short] version 2025.1.1 or later. For further information see [About SCASS](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/about-sca-scan-service.html).
* See IP address notice above for details on related IP configuration for your deployments.
### Resolved issues
@@ -646,7 +646,7 @@
* In addition to node_modules, bin, build, .git, .gradle, out, packages, target, the Gradle wrapper directory `gradle` will be excluded from signature scan by default. Use
[detect.excluded.directories.defaults.disabled](properties/configuration/paths.md#detect-excluded-directories-defaults-disabled-advanced) to disable these defaults.
* Removed reliance on [company_name] [solution_name] libraries for init-detect.gradle script to prevent them from being included in the Gradle dependency verification of target projects.
-[company_name] [solution_name] 7.x has entered end of support. See the [Product Maintenance, Support, and Service Schedule page](https://sig-product-docs.synopsys.com/bundle/blackduck-compatibility/page/topics/Support-and-Service-Schedule.html) for further details.
+[company_name] [solution_name] 7.x has entered end of support. See the [Product Maintenance, Support, and Service Schedule page](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/black-duck-sca-release-compatibility.html) for further details.
### Resolved issues
diff --git a/documentation/src/main/markdown/runningdetect/autonomousscan.dita b/documentation/src/main/markdown/runningdetect/autonomousscan.dita
index 829c8c9bf8..cf96726c1a 100644
--- a/documentation/src/main/markdown/runningdetect/autonomousscan.dita
+++ b/documentation/src/main/markdown/runningdetect/autonomousscan.dita
@@ -93,26 +93,26 @@
STATELESS.
- Intelligent scan: Runs when scan mode is not set to RAPID or STATELESS,
+
Intelligent scan: Runs when scan mode is not set to RAPID or STATELESS,
or --detect.blackduck.scan.mode is explicitly set
to INTELLIGENT.
- OFFLINE mode: When
+
OFFLINE mode: When
--blackduck.offline.mode is true or there is no url or proxy information provided. (Warning
messages will be logged for binary and signature scans if applicable tools
are not available or related parameters not set.)
-
-
Binary scan: Will run if
+
Binary scan: Will run if
one or more binary files exist in the scan directory and configuration is
completed.
-
Signature scan: Will run against source files if scan cli is
- available. If scan cli is not locally
+ available. If scan cli is not locally
available, it will need to be downloaded from .
@@ -305,7 +305,7 @@
Results
- Autonomous scan findings will be stored in a BDIO file when run without .
+ Autonomous scan findings will be stored in a BDIO file when run without .
Autonomous scan findings will appear in the
user interface if is configured.
diff --git a/documentation/src/main/markdown/runningdetect/basics/choosingrunmethod.md b/documentation/src/main/markdown/runningdetect/basics/choosingrunmethod.md
index f3f2fc0989..8bb9ab094c 100644
--- a/documentation/src/main/markdown/runningdetect/basics/choosingrunmethod.md
+++ b/documentation/src/main/markdown/runningdetect/basics/choosingrunmethod.md
@@ -13,11 +13,11 @@ Auto-update provides the following default behaviour:
Downloading and running the latest unversioned `detect.sh/ps1` script will use the latest version of the [detect_product_short] .jar file; downloading it for you if necessary.
-Running a versioned `detect.sh/ps1` script such as `detect11.sh/ps1` will use the latest version of the [detect_product_short] .jar file within that specific major version; downloading it for you if necessary.
+Running a versioned `detect.sh/ps1` script such as `detect12.sh/ps1` will use the latest version of the [detect_product_short] .jar file within that specific major version; downloading it for you if necessary.
To override the auto-update functionality by specifying an exact [detect_product_short] version, see: [To run a specific version of Detect](runningscript.md#to-run-a-specific-version-of-detect).
-If you are running [detect_product_short] with [bd_product_short] you can also configure the version of [detect_product_short] that should be used. See [Hosting location for Black Duck Detect](https://documentation.blackduck.com/bundle/bd-hub/page/ComponentDiscovery/DetectLocation.html).
+If you are running [detect_product_short] with [bd_product_short] you can also configure the version of [detect_product_short] that should be used. See [Hosting location for Black Duck Detect](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/hosting-location-for-black-duck-detect.html).
When you run [detect_product_short] via one of the provided scripts, you automatically pick up fixes and new features as they are released.
@@ -25,19 +25,19 @@ If you are running [detect_product_short] with [bd_product_short] you can also c
|---|---|-------------|---|
| Latest | Bash | detect.sh | Runs latest Detect |
| Latest | PowerShell | detect.ps1 | Runs latest Detect |
+| 12 | Bash | detect12.sh | Runs latest Detect 12 |
+| 12 | PowerShell | detect12.ps1 | Runs latest Detect 12 |
| 11 | Bash | detect11.sh | Runs latest Detect 11 |
| 11 | PowerShell | detect11.ps1 | Runs latest Detect 11 |
| 10 | Bash | detect10.sh | Runs latest Detect 10 |
| 10 | PowerShell | detect10.ps1 | Runs latest Detect 10 |
-| 9 | Bash | detect9.sh | Runs latest Detect 9 |
-| 9 | PowerShell | detect9.ps1 | Runs latest Detect 9 |
References to [detect_product_short] scripts within this documentation assume you are running the current release.
# JAR file
The primary reason to run the [detect_product_short] .jar directly is that this method provides
-direct control over the exact [detect_product_short] version. [detect_product_short] does not automatically update in this scenario unless configured in [bd_product_short] to do so. See [Hosting location for Black Duck Detect](https://documentation.blackduck.com/bundle/bd-hub/page/ComponentDiscovery/DetectLocation.html).
+direct control over the exact [detect_product_short] version. [detect_product_short] does not automatically update in this scenario unless configured in [bd_product_short] to do so. See [Hosting location for Black Duck Detect](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/hosting-location-for-black-duck-detect.html).
# Docker container
diff --git a/documentation/src/main/markdown/runningdetect/basics/runningjar.md b/documentation/src/main/markdown/runningdetect/basics/runningjar.md
index c1288243cc..efe4dc978d 100644
--- a/documentation/src/main/markdown/runningdetect/basics/runningjar.md
+++ b/documentation/src/main/markdown/runningdetect/basics/runningjar.md
@@ -11,7 +11,7 @@ java -jar {path to .jar file}
For example:
````
-curl -O https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/11.3.0/detect-11.3.0.jar
+curl -O https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/12.0.0/detect-12.0.0.jar
java -jar detect-11.3.0.jar
````
diff --git a/documentation/src/main/markdown/runningdetect/basics/runningscript.md b/documentation/src/main/markdown/runningdetect/basics/runningscript.md
index 90f0c9e34a..b89c353b14 100644
--- a/documentation/src/main/markdown/runningdetect/basics/runningscript.md
+++ b/documentation/src/main/markdown/runningdetect/basics/runningscript.md
@@ -31,14 +31,14 @@ See [Quoting and escaping shell script arguments](../../scripts/script-escaping-
````
export DETECT_LATEST_RELEASE_VERSION={Detect version}
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh)
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh)
````
-For example, to run [detect_product_short] version 9.10.0:
+For example, to run [detect_product_short] version 10.5.0:
````
-export DETECT_LATEST_RELEASE_VERSION=9.10.0
-bash <(curl -s -L https://detect.blackduck.com/detect9.sh)
+export DETECT_LATEST_RELEASE_VERSION=10.5.0
+bash <(curl -s -L https://detect.blackduck.com/detect10.sh)
````
## Running the script on Windows
@@ -80,7 +80,7 @@ powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://d
To download and run the latest version of [detect_product_short] in a single command from PowerShell:
````
-[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect
+[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect
````
_Note that when running the above command, the PowerShell session is not exited. See [here](../../scripts/script-escaping-special-characters.md) for more information on the difference between the two commands._
diff --git a/documentation/src/main/markdown/runningdetect/basics/runningwithblackduck.md b/documentation/src/main/markdown/runningdetect/basics/runningwithblackduck.md
index 4052fa9a39..b15196414f 100644
--- a/documentation/src/main/markdown/runningdetect/basics/runningwithblackduck.md
+++ b/documentation/src/main/markdown/runningdetect/basics/runningwithblackduck.md
@@ -19,7 +19,7 @@ project directory.
* Run the [dockerinspector_name] on a given [Docker image](../../packagemgrs/docker/intro.md).
* Generate a [report](../../properties/configuration/report.md).
* Fail on [policy violation](../../properties/configuration/project.md#fail-on-policy-violation-severities-advanced).
-* Run [IaC Scan](../iacscan.md) on provided targets. Note: Iac Scan capabilities require [bd_product_short] 2022.7.0 or later.
+* Run [IaC Scan](../iacscan.md) on provided targets.
Refer to [Black Duck SCA Server properties](../../properties/configuration/blackduck-server.md), [Black Duck Signature Scanner properties](../../properties/configuration/signature-scanner.md), and [IaC Scan](../iacscan.md) for details.
diff --git a/documentation/src/main/markdown/runningdetect/iacscan.md b/documentation/src/main/markdown/runningdetect/iacscan.md
index 8cf523e282..068268f649 100644
--- a/documentation/src/main/markdown/runningdetect/iacscan.md
+++ b/documentation/src/main/markdown/runningdetect/iacscan.md
@@ -4,7 +4,7 @@ IaC ("Infrastructure as Code") Scan is a type of scanning supported by [detect_p
To configure IaC Scan, see [IaC Scan properties](../properties/configuration/iac-scan.md#iac-scan-arguments).
-See the [blackduck_product_name] documentation for futher details on Infrastructure as Code scanning.
+See the [blackduck_product_name] documentation for futher details on Infrastructure as Code scanning.
## Known Issues
diff --git a/documentation/src/main/markdown/runningdetect/rapidscan.md b/documentation/src/main/markdown/runningdetect/rapidscan.md
index f10f0cdd84..7be5659d07 100644
--- a/documentation/src/main/markdown/runningdetect/rapidscan.md
+++ b/documentation/src/main/markdown/runningdetect/rapidscan.md
@@ -83,7 +83,7 @@ The results are also printed in the logs:
2021-07-20 13:25:18 EDT INFO [main] --- Components with Policy Violation Warnings:
2021-07-20 13:25:18 EDT INFO [main] --- Acorn 5.5.3 (npmjs:acorn/5.5.3)
```
-For [detect_product_short] version 8.7.0 and later, with [bd_product_short] 2023.1.2, Rapid Scan output now reports upgrade guidance for transitive dependencies with known vulnerabilities. The output gives information as to the direct dependency upgrade options and the transitive dependencies affected. This output is given in the results section which appears near the end of the [detect_product_short] run and appears as follows:
+Rapid Scan output reports upgrade guidance for transitive dependencies with known vulnerabilities. The output gives information as to the direct dependency upgrade options and the transitive dependencies affected. This output is given in the results section which appears near the end of the [detect_product_short] run and appears as follows:
```
2023-03-09 13:01:56 EST INFO [main] --- ===== Transitive Guidance =====
2023-03-09 13:01:56 EST INFO [main] ---
@@ -111,8 +111,8 @@ You can configure Rapid Scan to return only the difference in policy violations
To return only the difference in policy violations, configure `detect.blackduck.rapid.compare.mode` to `BOM_COMPARE` or `BOM_COMPARE_STRICT`.
-BOM_COMPARE: Will evaluate policy rules based on the type of [policy rule modes](https://documentation.blackduck.com/bundle/bd-hub/page/Policies/CreatePolicy.html) configured. When the policy rule is set to (`RAPID` and `FULL`) it will behave like `BOM_COMPARE_STRICT` but if the policy rule is only (`RAPID`) it will evaluate the result of the Rapid Scan against the policy, ignoring results in the BOM.
+BOM_COMPARE: Will evaluate policy rules based on the type of [policy rule modes](https://docs.blackduck.com/r/blackduck/latest/black-duck-documentation/managing-policies.html) configured. When the policy rule is set to (`RAPID` and `FULL`) it will behave like `BOM_COMPARE_STRICT` but if the policy rule is only (`RAPID`) it will evaluate the result of the Rapid Scan against the policy, ignoring results in the BOM.
BOM_COMPARE_STRICT: Will only evaluate policy rules that are (`RAPID` and `FULL`). Policy violations are compared to the existing project version BOM. If the policy violation was already known and visible in the BOM (active or overridden) it is not part of the rapid scan positive result, it will still be part of the full result following existing restrictions.
-BOM compare mode settings determine which policies are considered and how they behave when violations are present. See the [bd_product_short] documentation for futher details on Rapid Scanning.
+BOM compare mode settings determine which policies are considered and how they behave when violations are present. See the [bd_product_short] documentation for futher details on Rapid Scanning.
diff --git a/documentation/src/main/markdown/runningdetect/runincontainer.md b/documentation/src/main/markdown/runningdetect/runincontainer.md
index cb3ffa9515..ae08a0c974 100644
--- a/documentation/src/main/markdown/runningdetect/runincontainer.md
+++ b/documentation/src/main/markdown/runningdetect/runincontainer.md
@@ -23,9 +23,9 @@ Find available images via [Docker public image registry](https://hub.docker.com/
Example pull commmands:
```
#hub.docker.com
-docker pull blackducksoftware/detect:10.4.0
+docker pull blackducksoftware/detect:12.0.0
#repo.blackduck.com
-docker pull repo.blackduck.com/containers/blackducksoftware/detect:10.4.0
+docker pull repo.blackduck.com/containers/blackducksoftware/detect:12.0.0
```
Find the source, Dockerfiles [here](https://github.com/blackducksoftware/detect-docker).
@@ -61,11 +61,13 @@ The format of "iac" image names is: `blackducksoftware/detect:[detect_version]-i
`docker run -it --rm -v [/path/to/source]:/source -v [/path/to/outputDir]:/output blackducksoftware/detect:[detect_image_tag] [detect_arguments]`
-`docker run -it --rm -v /home/my/gradle/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:10.0.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn`
+`docker run -it --rm -v /home/my/gradle/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:12.0.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn`
-`docker run -it --rm -v /home/my/maven/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:9 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn`
+`docker run -it --rm -v /home/my/gradle/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:11.0.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn`
-`docker run -it --rm -v /home/my/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:9.7.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn --detect.accuracy.required=NONE`
+`docker run -it --rm -v /home/my/maven/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:10 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn`
-`docker run -it --rm -v /home/my/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:9.6.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn --detect.tools=SIGNATURE_SCAN,BINARY_SCAN`
+`docker run -it --rm -v /home/my/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:10.7.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn --detect.accuracy.required=NONE`
+
+`docker run -it --rm -v /home/my/project:/source -v /home/for/detect/output/files:/output blackducksoftware/detect:10.6.0 --blackduck.url=https://my.blackduck.url --blackduck.api.token=MyT0kEn --detect.tools=SIGNATURE_SCAN,BINARY_SCAN`
diff --git a/documentation/src/main/markdown/runningdetect/statelessscan.md b/documentation/src/main/markdown/runningdetect/statelessscan.md
index 39e0936956..d43729763c 100644
--- a/documentation/src/main/markdown/runningdetect/statelessscan.md
+++ b/documentation/src/main/markdown/runningdetect/statelessscan.md
@@ -49,7 +49,7 @@ Enable this feature by adding [--detect.blackduck.scan.mode=STATELESS](../proper
Unlike persistent scans, no data is stored on [bd_product_short] and all scans are done transiently. These scans are primarily intended to be fast, although they can take some time as communication with [bd_product_short] is a requirement as it is reliant on [bd_product_short] policies.
-[detect_product_short] intentionally fails with FAILURE_POLICY_VIOLATION if any component violates [bd_product_short] polices with a CRITICAL or BLOCKER severity. See the [bd_product_short] documentation on Policy Managment
+[detect_product_short] intentionally fails with FAILURE_POLICY_VIOLATION if any component violates [bd_product_short] polices with a CRITICAL or BLOCKER severity. See the [bd_product_short] documentation on Policy Managment
for a list of policy conditions that are supported by Stateless Scan.
The results are saved to a json file named `name_version_BlackDuck_DeveloperMode_Result.json` in the Scan Output directory, where name and version are the project's name and version.
@@ -86,7 +86,7 @@ The results of a Stateless Scan are also printed in the logs:
2021-07-20 13:25:18 EDT INFO [main] --- Components with Policy Violation Warnings:
2021-07-20 13:25:18 EDT INFO [main] --- Acorn 5.5.3 (npmjs:acorn/5.5.3)
```
-For [detect_product_short] version 8.7.0 and later, with [bd_product_short] 2023.1.2, Rapid Scan output reports upgrade guidance for transitive dependencies with known vulnerabilities. The output gives information as to the direct dependency upgrade options and the transitive dependencies affected. This output is given in the results section which appears near the end of the [detect_product_short] run and appears as follows:
+Rapid Scan output reports upgrade guidance for transitive dependencies with known vulnerabilities. The output gives information as to the direct dependency upgrade options and the transitive dependencies affected. This output is given in the results section which appears near the end of the [detect_product_short] run and appears as follows:
```
2023-03-09 13:01:56 EST INFO [main] --- ===== Transitive Guidance =====
2023-03-09 13:01:56 EST INFO [main] ---
@@ -106,11 +106,10 @@ For [detect_product_short] version 8.7.0 and later, with [bd_product_short] 2023
```
For further remediation and transitive dependency upgrade guidance, please consult the documentation provided by [bd_product_short] under the topic:
-Getting remediation guidance for components with security vulnerabilities.
-
+Getting remediation guidance for components with security vulnerabilities
## Stateless Scan Compare Mode
You can configure Package Manager, Signature, and Container Stateless Scans to return only the difference in identified policy violations between the current scan and previous Persistent Scans, using the same scan configuration. To return only the difference in policy violations, configure `detect.blackduck.rapid.compare.mode` to `BOM_COMPARE` or `BOM_COMPARE_STRICT`.
-BOM compare mode settings determine which policies are considered and how they behave when violations are present. See the [bd_product_short] documentation for futher details on BOM comparison.
+BOM compare mode settings determine which policies are considered and how they behave when violations are present. See the [bd_product_short] documentation for futher details on BOM comparison.
diff --git a/documentation/src/main/markdown/scripts/overview.md b/documentation/src/main/markdown/scripts/overview.md
index 2b600ce5e9..43f877068d 100644
--- a/documentation/src/main/markdown/scripts/overview.md
+++ b/documentation/src/main/markdown/scripts/overview.md
@@ -22,7 +22,7 @@ Refer to [Running the Detect script](../runningdetect/basics/runningscript.md) f
| Variable | Purpose | Value | Notes |
|---------------------------------------------|---------------------------------------------------------------------| --------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| DETECT_SOURCE | Download the [detect_product_short] .jar from a given URL | The URL of the [detect_product_short] .jar file to download and run | |
-| DETECT_LATEST_RELEASE_VERSION | Run a given [detect_product_short] version | A [detect_product_short] version (example: 11.0.0) | If you would like to run a [detect_product_short] version other than the latest, set DETECT_LATEST_RELEASE_VERSION to the [detect_product_short] version you would like to run (for example: 11.0.0). DETECT_SOURCE has precedence over DETECT_LATEST_RELEASE_VERSION. You can see the available [detect_product_short] versions in the binary repository specified in [download locations](../downloadingandinstalling/downloadlocations.md). |
+| DETECT_LATEST_RELEASE_VERSION | Run a given [detect_product_short] version | A [detect_product_short] version (example: 12.0.0) | If you would like to run a [detect_product_short] version other than the latest, set DETECT_LATEST_RELEASE_VERSION to the [detect_product_short] version you would like to run (for example: 12.0.0). DETECT_SOURCE has precedence over DETECT_LATEST_RELEASE_VERSION. You can see the available [detect_product_short] versions in the binary repository specified in [download locations](../downloadingandinstalling/downloadlocations.md). |
| DETECT_VERSION_KEY | Continue running an earlier major version of [detect_product_short] | DETECT_LATEST (default), DETECT_LATEST_10, DETECT_LATEST_9 | If neither DETECT_SOURCE nor DETECT_LATEST_RELEASE_VERSION is specified, the script will use the version key to query Artifactory for the correct version to download. By default it will look for DETECT_LATEST, however the [detect_product_short] artifactory also includes keys for some of the major versions of [detect_product_short] such as DETECT_LATEST_9. You can view the available values for DETECT_VERSION_KEY in [detect_product_short] project in the binary repository specified in [download locations](../downloadingandinstalling/downloadlocations.md). |
| DETECT_JAR_PATH | Change the [detect_product_short] .jar download dir | The path to the .jar file download directory | If DETECT_JAR_PATH is provided, the script will use this location when downloading and running detect. The location of the jar will be DETECT_JAR_PATH/[detect_product_lowercase]-{version}.jar. The Bash script will default to '{user home directory}/detect/download' if no option is specified. |
| TMP (PowerShell only) | Provides the user's temporary directory | The path to a directory for temporary files | If DETECT_JAR_PATH is not provided, the script will use the environment 'TMP' variable as the folder for the [detect_product_short] .jar path. |
diff --git a/documentation/src/main/markdown/scripts/script-escaping-special-characters.md b/documentation/src/main/markdown/scripts/script-escaping-special-characters.md
index 5bbd82cfca..c6879a2d3c 100644
--- a/documentation/src/main/markdown/scripts/script-escaping-special-characters.md
+++ b/documentation/src/main/markdown/scripts/script-escaping-special-characters.md
@@ -13,19 +13,19 @@ When an argument contains a space or other non double quote special character, y
For example:
```
# name: Project Test
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name='Project Test'
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name='Project Test'
# name: Project Test
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name=Project\ Test
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=Project\ Test
# name: Project!Test
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.name=Project\!Test
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.name=Project\!Test
```
You can include a double quote by single quoting the string, and escaping the double quotes with backslashes:
```
# license: BSD 3-clause "New" or "Revised" License
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) --detect.project.version.license='BSD 3-clause \"New\" or \"Revised\" License'
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) --detect.project.version.license='BSD 3-clause \"New\" or \"Revised\" License'
```
## Running in Command Prompt (cmd) on Windows ([powershell_script_name])
@@ -43,13 +43,13 @@ When an argument contains a space or other non quote special character, you can
For example:
```
# name: Project Test
-powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect" --detect.project.name='Project Test'
+powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.name='Project Test'
# name: Project Test
-powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect" '--detect.project.name=Project Test'
+powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" '--detect.project.name=Project Test'
# name: Project Test
-powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect" --detect.project.name=Project` Test
+powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.name=Project` Test
```
When an argument contains a comma, you can wrap the argument in single quotes, and escape the special character with a backtick (`). In the case of a name with a comma and a space, you would use a backtick in front of both the comma and space.
@@ -57,25 +57,25 @@ When an argument contains a comma, you can wrap the argument in single quotes, a
For example:
```
# name: Project,Test
-Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --blackduck.url= --detect.project.name='Project,Test'"
+Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --blackduck.url= --detect.project.name='Project,Test'"
# name: Project,Test
-Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --blackduck.url= '--detect.project.name=Project,Test'"
+Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --blackduck.url= '--detect.project.name=Project,Test'"
# name: Project, Test
-Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --blackduck.url= --detect.project.name=Project`,` Test"
+Powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --blackduck.url= --detect.project.name=Project`,` Test"
```
You can include a single quote by doubling it:
```
# name: singlequote'
-powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect" --detect.project.name='singlequote'''
+powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.name='singlequote'''
```
You can include a double quote using this sequence: double quote, 2 backslashes, 2 double quotes:
```
# license: BSD 3-clause "New" or "Revised" License
-powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect" --detect.project.version.license='BSD 3-clause "\\""New"\\"" or "\\""Revised"\\"" License'
+powershell "[Net.ServicePointManager]::SecurityProtocol = 'tls12'; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect" --detect.project.version.license='BSD 3-clause "\\""New"\\"" or "\\""Revised"\\"" License'
```
## Running in PowerShell on Windows ([powershell_script_name])
@@ -93,10 +93,10 @@ When an argument contains a space or other non-quote special character, you can
For example:
```
# name: Project Test
-[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --detect.project.name='Project Test'
+[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --detect.project.name='Project Test'
# name: Project Test
-[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect "--detect.project.name=Project Test"
+[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect "--detect.project.name=Project Test"
```
When an argument contains a comma, you must escape the special character with a backtick (`). In the case of a name with a comma and a space, you would use a backtick in front of both the comma and space.
@@ -115,5 +115,5 @@ For example:
You can include a double quote using this sequence: backslash, backtick, double quote:
```
# license: BSD 3-clause "New" or "Revised" License
-[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect11.ps1?$(Get-Random) | iex; detect --detect.project.version.license="BSD 3-clause \`"New\`" or \`"Revised\`" License"
+[Net.ServicePointManager]::SecurityProtocol = 'tls12'; $Env:DETECT_EXIT_CODE_PASSTHRU=1; irm https://detect.blackduck.com/detect12.ps1?$(Get-Random) | iex; detect --detect.project.version.license="BSD 3-clause \`"New\`" or \`"Revised\`" License"
```
diff --git a/documentation/src/main/markdown/troubleshooting/commonproblems.md b/documentation/src/main/markdown/troubleshooting/commonproblems.md
index 9639b76370..4f56ba2767 100644
--- a/documentation/src/main/markdown/troubleshooting/commonproblems.md
+++ b/documentation/src/main/markdown/troubleshooting/commonproblems.md
@@ -1,6 +1,6 @@
# Common [detect_product_short] complications
-- Problems may occur due to incompatible [detect_product_long] / [bd_product_long] versions. Consult the [Compatibility Matrix](https://documentation.blackduck.com/bundle/blackduck-compatibility/page/topics/Black-Duck-Release-Compatibility.html) to verify your combination. Attempting to reproduce the problem using the latest version of [bd_product_short] with the latest version of [bd_product_short] might also assist in determining if the issue has been resolved.
+- Problems may occur due to incompatible [detect_product_long] / [bd_product_long] versions. Consult the [Compatibility Matrix](https://docs.blackduck.com/r/blackduck/black-duck-compatibility-reference/black-duck-sca-release-compatibility.html) to verify your combination. Attempting to reproduce the problem using the latest version of [bd_product_short] with the latest version of [bd_product_short] might also assist in determining if the issue has been resolved.
- Remember to consider the possibility that the [bd_product_short] user lacks the necessary permissions (to create the project, update the BOM, receive notifications, etc.) in [bd_product_short]. For more information, see [Black Duck user role requirements](../gettingstarted/usersandroles.md).
- Confirm that the [bd_product_short] server (registration key) has the required capabilities enabled (binary upload, snippet scanning, etc.).
diff --git a/documentation/src/main/markdown/troubleshooting/solutions.md b/documentation/src/main/markdown/troubleshooting/solutions.md
index e6d3f64ed7..463801b10f 100644
--- a/documentation/src/main/markdown/troubleshooting/solutions.md
+++ b/documentation/src/main/markdown/troubleshooting/solutions.md
@@ -300,7 +300,7 @@ Expected behavior for Bazel versions before 6.0: the tool assumes WORKSPACE mode
#### Debug Mode
For detailed logging to diagnose issues:
```sh
-bash <(curl -s -L https://detect.blackduck.com/detect11.sh) \
+bash <(curl -s -L https://detect.blackduck.com/detect12.sh) \
--logging.level.detect=DEBUG \
--detect.bazel.target='//your:target'
```
diff --git a/documentation/src/main/resources/templates/ditamap.ftl b/documentation/src/main/resources/templates/ditamap.ftl
index 8a76dee0b8..624e8bd517 100644
--- a/documentation/src/main/resources/templates/ditamap.ftl
+++ b/documentation/src/main/resources/templates/ditamap.ftl
@@ -4,17 +4,8 @@
${solution_name} ${program_version}
${solution_name} is a client that scans code bases in your projects and folders to perform compositional analysis.
-
-
-
-
-
-
-
-
diff --git a/documentation/src/main/resources/templates/downloadlocations.ftl b/documentation/src/main/resources/templates/downloadlocations.ftl
index 8b1ecf00cf..938eef73d4 100644
--- a/documentation/src/main/resources/templates/downloadlocations.ftl
+++ b/documentation/src/main/resources/templates/downloadlocations.ftl
@@ -11,10 +11,9 @@ The following are download locations for the current version of [detect_product_
* Black Duck Security Setup: [Integrations oboarding](https://integrations.blackduck.com/onboard/)
* For additional integrations with [bd_product_long], Azure, and GitHub, see:
- * [Security Scan for Black Duck SCA](https://documentation.blackduck.com/bundle/bridge-docs/page/bridge/documentation/security_scan_for_black_duck.html)
- * [Bridge Azure Plugin](https://documentation.blackduck.com/bundle/bridge-docs/page/bridge/documentation/c_azure-with-blackduck.html)
- * [GitHub App](https://documentation.blackduck.com/bundle/bridge-docs/page/bridge/documentation/c_github-blackduck-security-scan-app-sca.html)
-
+ * [Security Scan for Black Duck SCA](https://docs.blackduck.com/r/bridge/latest/bridge-cli-guide/quickstart-black-duck-security-scan-pipe-with-black-duck-sca.html)
+ * [Bridge Azure Plugin](https://docs.blackduck.com/r/bridge/latest/bridge-cli-guide/azure-devops-integrations.html)
+ * [GitHub App](https://docs.blackduck.com/r/bridge/latest/bridge-cli-guide/github-app-black-duck-security.html)
Legacy [detect_product_short] plugins:
* [detect_product_long] Jenkins plugin is available here: [Jenkins plugin](https://plugins.jenkins.io/blackduck-detect/)
* [detect_product_long] extension for Azure DevOps is available on the: [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=blackduck.blackduck-detect)
diff --git a/documentation/topics.ditamap b/documentation/topics.ditamap
index 8d3a508ffc..f073f48c92 100644
--- a/documentation/topics.ditamap
+++ b/documentation/topics.ditamap
@@ -4,17 +4,7 @@
Black Duck Detect User Guide
Black Duck Detect
-
- Black Duck Detect
-
-
-
-
-
-
-
-
diff --git a/src/main/java/com/blackduck/integration/detect/configuration/DetectProperties.java b/src/main/java/com/blackduck/integration/detect/configuration/DetectProperties.java
index e9f5fed3d6..84becfd44f 100644
--- a/src/main/java/com/blackduck/integration/detect/configuration/DetectProperties.java
+++ b/src/main/java/com/blackduck/integration/detect/configuration/DetectProperties.java
@@ -110,7 +110,7 @@ private DetectProperties() {
.setInfo("Bypass Proxy Hosts", DetectPropertyFromVersion.VERSION_4_2_0)
.setHelp(
"A comma separated list of regular expression host patterns that should not use the proxy.",
- "This property accepts Java regular expressions. For further information refer to Java regular expression support page."
+ "This property accepts Java regular expressions. For further information refer to Java regular expression support page."
)
.setGroups(DetectGroup.PROXY, DetectGroup.BLACKDUCK, DetectGroup.DEFAULT)
.setCategory(DetectCategory.Advanced)
@@ -178,7 +178,7 @@ private DetectProperties() {
.setInfo("Detector Accuracy Requirements", DetectPropertyFromVersion.VERSION_7_13_0)
.setHelp(
"Detector types from which HIGH accuracy results are required when a detector of that type applies.",
- "The value of this property only affects detector types which apply to the source project. If a detector type applies, and is one of the accuracy-required detector types indicated by the value of this property, low accuracy results for that detector type are treated as a failure. For further information refer to Detector search and accuracy."
+ "The value of this property only affects detector types which apply to the source project. If a detector type applies, and is one of the accuracy-required detector types indicated by the value of this property, low accuracy results for that detector type are treated as a failure. For further information refer to Detector search and accuracy."
)
.setGroups(DetectGroup.DETECTOR, DetectGroup.GLOBAL)
.setExample("ALL,NONE")
@@ -353,7 +353,7 @@ private DetectProperties() {
StringListProperty.newBuilder("detect.binary.scan.file.name.patterns", emptyList())
.setInfo("Binary Scan Filename Patterns", DetectPropertyFromVersion.VERSION_6_0_0)
.setHelp(
- "If specified, files in the source directory whose names match these file name patterns will be zipped and uploaded for binary scan analysis. This property will not be used if detect.binary.scan.file.path is specified. Search depth is controlled by property detect.binary.scan.search.depth. Directories specified via property detect.excluded.directories are excluded from the file search. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page.")
+ "If specified, files in the source directory whose names match these file name patterns will be zipped and uploaded for binary scan analysis. This property will not be used if detect.binary.scan.file.path is specified. Search depth is controlled by property detect.binary.scan.search.depth. Directories specified via property detect.excluded.directories are excluded from the file search. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page.")
.setGroups(DetectGroup.BINARY_SCANNER, DetectGroup.SOURCE_PATH)
.setExample("*.jar")
.build();
@@ -551,7 +551,7 @@ private DetectProperties() {
)
.setInfo("Reduced Persistence", DetectPropertyFromVersion.VERSION_8_3_0)
.setHelp(
- "Use this value to control how unmatched files from signature scans are stored. For a full explanation, refer to about reduced persistence signature scanning."
+ "Use this value to control how unmatched files from signature scans are stored. For a full explanation, refer to about reduced persistence signature scanning."
)
.setGroups(DetectGroup.SIGNATURE_SCANNER, DetectGroup.GLOBAL)
.build();
@@ -754,7 +754,7 @@ private DetectProperties() {
.setInfo("Detector Search Continue", DetectPropertyFromVersion.VERSION_3_2_0)
.setHelp(
"By default, nesting rules limit which detectors can run on a subdirectory based on which detectors applied on any parent directory. Setting this property to true disables nesting rules.",
- "For further explanation on nesting rules, refer to Detector search and accuracy."
+ "For further explanation on nesting rules, refer to Detector search and accuracy."
)
.setGroups(DetectGroup.PATHS, DetectGroup.DETECTOR, DetectGroup.GLOBAL, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -765,7 +765,7 @@ private DetectProperties() {
.setInfo("Diagnostic Mode", DetectPropertyFromVersion.VERSION_6_5_0)
.setHelp(
"When enabled, diagnostic mode collects files valuable for troubleshooting (logs, BDIO file, extraction files, reports, etc.), writes them to a zip file, and logs the path to the zip file.",
- "See the following for more Diagnostic Mode information.")
+ "See the following for more Diagnostic Mode information.")
.setGroups(DetectGroup.DEBUG, DetectGroup.GLOBAL)
.build();
@@ -990,7 +990,7 @@ private DetectProperties() {
.setInfo("Gradle Exclude Configurations", DetectPropertyFromVersion.VERSION_3_0_0)
.setHelp(
"A comma-separated list of Gradle configurations to exclude.",
- "As Detect examines the Gradle project for dependencies, Detect will skip any Gradle configurations specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect examines the Gradle project for dependencies, Detect will skip any Gradle configurations specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.GRADLE, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1001,7 +1001,7 @@ private DetectProperties() {
.setInfo("Gradle Exclude Projects", DetectPropertyFromVersion.VERSION_3_0_0)
.setHelp(
"A comma-separated list of Gradle subprojects to exclude.",
- "As Detect examines the Gradle project for dependencies, Detect will skip any Gradle subprojects specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect examines the Gradle project for dependencies, Detect will skip any Gradle subprojects specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.GRADLE, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1012,7 +1012,7 @@ private DetectProperties() {
.setInfo("Gradle Exclude Subproject Paths", DetectPropertyFromVersion.VERSION_7_12_0)
.setHelp(
"A comma-separated list of Gradle subproject paths to exclude.",
- "As Detect examines the Gradle project for dependencies, Detect will skip any Gradle subproject whose path matches one of the values passed via this property. Run 'gradle projects' to see the paths to your subprojects. Subproject paths have the form ':subproject:subsubproject' and are unique. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect examines the Gradle project for dependencies, Detect will skip any Gradle subproject whose path matches one of the values passed via this property. Run 'gradle projects' to see the paths to your subprojects. Subproject paths have the form ':subproject:subsubproject' and are unique. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.GRADLE, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1023,7 +1023,7 @@ private DetectProperties() {
.setInfo("Gradle Include Configurations", DetectPropertyFromVersion.VERSION_3_0_0)
.setHelp(
"A comma-separated list of Gradle configurations to include.",
- "As Detect examines the Gradle project for dependencies, if this property is set, Detect will include only those Gradle configurations specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect examines the Gradle project for dependencies, if this property is set, Detect will include only those Gradle configurations specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.GRADLE, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1045,7 +1045,7 @@ private DetectProperties() {
.setInfo("Gradle Include Projects", DetectPropertyFromVersion.VERSION_3_0_0)
.setHelp(
"A comma-separated list of Gradle subprojects to include.",
- "As Detect examines the Gradle project for dependencies, if this property is set, Detect will include only those subprojects specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect examines the Gradle project for dependencies, if this property is set, Detect will include only those subprojects specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.GRADLE, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1056,7 +1056,7 @@ private DetectProperties() {
.setInfo("Gradle Include Project Paths", DetectPropertyFromVersion.VERSION_7_12_0)
.setHelp(
"A comma-separated list of Gradle subproject paths to include.",
- "As Detect examines the Gradle project for dependencies, if this property is set, Detect will include only those subprojects whose path matches this property. Gradle project paths usually take the form ':parent:child' and are unique. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect examines the Gradle project for dependencies, if this property is set, Detect will include only those subprojects whose path matches this property. Gradle project paths usually take the form ':parent:child' and are unique. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.GRADLE, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1092,7 +1092,7 @@ private DetectProperties() {
.setInfo("Detect Excluded Directories", DetectPropertyFromVersion.VERSION_7_0_0)
.setHelp(
"A comma-separated list of names, name patterns, relative paths, or path patterns of directories that Detect should exclude. Caution should be exercised when including this parameter on Windows, as the command length generated may exceed OS limitations.",
- "Subdirectories whose name or path is resolved from the patterns in this list will not be searched when determining which detectors to run, will not be searched to find files for binary scanning when property detect.binary.scan.file.name.patterns is set, and will be excluded from signature scan using the Scan CLI '--exclude' flag. For further information, refer to the Including and Excluding Tools, Detectors, Directories page."
+ "Subdirectories whose name or path is resolved from the patterns in this list will not be searched when determining which detectors to run, will not be searched to find files for binary scanning when property detect.binary.scan.file.name.patterns is set, and will be excluded from signature scan using the Scan CLI '--exclude' flag. For further information, refer to the Including and Excluding Tools, Detectors, Directories page."
)
.setGroups(DetectGroup.PATHS, DetectGroup.DETECTOR, DetectGroup.GLOBAL, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1142,7 +1142,7 @@ private DetectProperties() {
.setInfo("Quack Patch Enabled", DetectPropertyFromVersion.VERSION_11_2_0)
.setHelp(
"If set to true, Detect will invoke Quack Patch -- a tool that uses LLMs to generate code patches for vulnerable transitive components.",
- "Only supported for Rapid and Stateless Scan modes. detect.llm.api.key, detect.llm.api.endpoint, and detect.llm.name must also be set. See Quack Patch for further details.")
+ "Only supported for Rapid and Stateless Scan modes. detect.llm.api.key, detect.llm.api.endpoint, and detect.llm.name must also be set. See Quack Patch for further details.")
.setGroups(DetectGroup.QUACKPATCH)
.build();
@@ -1223,7 +1223,7 @@ private DetectProperties() {
.setInfo("Lerna Packages Excluded", DetectPropertyFromVersion.VERSION_7_0_0)
.setHelp(
"A comma-separated list of Lerna packages to exclude.",
- "As Detect parses the output of lerna ls --all --json, Detect will exclude any Lerna packages specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect parses the output of lerna ls --all --json, Detect will exclude any Lerna packages specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.LERNA, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1234,7 +1234,7 @@ private DetectProperties() {
.setInfo("Lerna Packages Included", DetectPropertyFromVersion.VERSION_7_0_0)
.setHelp(
"A comma-separated list of Lerna packages to include.",
- "As Detect parses the output of lerna ls --all --json2, if this property is set, Detect will include only those Lerna packages specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect parses the output of lerna ls --all --json2, if this property is set, Detect will include only those Lerna packages specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.LERNA, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1270,7 +1270,7 @@ private DetectProperties() {
.setInfo("Maven Modules Excluded", DetectPropertyFromVersion.VERSION_3_0_0)
.setHelp(
"A comma-separated list of Maven modules (subprojects) to exclude.",
- "As Detect parses the mvn dependency:tree output for dependencies, Detect will skip any Maven modules specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect parses the mvn dependency:tree output for dependencies, Detect will skip any Maven modules specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.MAVEN, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1281,7 +1281,7 @@ private DetectProperties() {
.setInfo("Maven Modules Included", DetectPropertyFromVersion.VERSION_3_0_0)
.setHelp(
"A comma-separated list of Maven modules (subprojects) to include.",
- "As Detect parses the mvn dependency:tree output for dependencies, if this property is set, Detect will include only those Maven modules specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "As Detect parses the mvn dependency:tree output for dependencies, if this property is set, Detect will include only those Maven modules specified via this property that are not excluded. Leaving this unset implies 'include all'. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.MAVEN, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1306,7 +1306,7 @@ private DetectProperties() {
.setInfo("Dependency Scope Included", DetectPropertyFromVersion.VERSION_6_0_0)
.setHelp(
"A comma separated list of Maven scopes. Output will be limited to dependencies within these scopes (overridden by exclude).",
- "If set, Detect will include only dependencies of the given Maven scope. This property accepts filename globbing-style wildcards. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "If set, Detect will include only dependencies of the given Maven scope. This property accepts filename globbing-style wildcards. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.MAVEN, DetectGroup.SOURCE_SCAN)
.build();
@@ -1316,7 +1316,7 @@ private DetectProperties() {
.setInfo("Dependency Scope Excluded", DetectPropertyFromVersion.VERSION_6_0_0)
.setHelp(
"A comma separated list of Maven scopes. Output will be limited to dependencies outside these scopes (overrides include).",
- "If set, Detect will include only dependencies outside of the given Maven scope. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "If set, Detect will include only dependencies outside of the given Maven scope. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.MAVEN, DetectGroup.SOURCE_SCAN)
.build();
@@ -1428,7 +1428,7 @@ private DetectProperties() {
public static final NoneEnumListProperty DETECT_NUGET_DEPENDENCY_TYPES_EXCLUDED =
NoneEnumListProperty.newBuilder("detect.nuget.dependency.types.excluded", NoneEnum.NONE, NugetDependencyType.class)
.setInfo("Nuget Dependency Types Excluded", DetectPropertyFromVersion.VERSION_9_4_0)
- .setHelp(createTypeFilterHelpText("Nuget dependency types"), "This property supports exclusion of dependencies in projects that use PackageReference, packages.config, project.lock.json or project.assets.json. This property does not apply to scans that analyze project.json. For more information, refer to excluding NuGet dependency types.")
+ .setHelp(createTypeFilterHelpText("Nuget dependency types"), "This property supports exclusion of dependencies in projects that use PackageReference, packages.config, project.lock.json or project.assets.json. This property does not apply to scans that analyze project.json. For more information, refer to excluding NuGet dependency types.")
.setExample(String.format("%s", NugetDependencyType.DEV.name()))
.setGroups(DetectGroup.NUGET, DetectGroup.GLOBAL, DetectGroup.SOURCE_SCAN)
.build();
@@ -1550,7 +1550,7 @@ private DetectProperties() {
.setInfo("pnpm Exclude Directories", DetectPropertyFromVersion.VERSION_10_4_0)
.setHelp(
"A comma-separated list of pnpm directories to exclude.",
- "If set, Detect will only exclude those pnpm directories specified via this property when examining the pnpm project for dependencies. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "If set, Detect will only exclude those pnpm directories specified via this property when examining the pnpm project for dependencies. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.PNPM, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1561,7 +1561,7 @@ private DetectProperties() {
.setInfo("pnpm Include Directories", DetectPropertyFromVersion.VERSION_10_4_0)
.setHelp(
"A comma-separated list of pnpm directories to include.",
- "If set, Detect will only include the pnpm directories specified via this property when examining the pnpm project for dependencies, unless the directory is set for exclusion. Exclusion rules take precedence over inclusion. Leaving this property unset implies 'include all'. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "If set, Detect will only include the pnpm directories specified via this property when examining the pnpm project for dependencies, unless the directory is set for exclusion. Exclusion rules take precedence over inclusion. Leaving this property unset implies 'include all'. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.PNPM, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -1967,7 +1967,7 @@ private DetectProperties() {
NullablePathProperty.newBuilder("detect.iac.scanner.local.path")
.setInfo("IaC Scanner Local Path", DetectPropertyFromVersion.VERSION_7_14_0)
.setHelp("Use this property to specify the path to a local IaC Scanner.",
- "If you are running in an Air Gap environment you may need to download the IaC Scanner(Sigma) binary from Artifactory. See the Download Locations page."
+ "If you are running in an Air Gap environment you may need to download the IaC Scanner(Sigma) binary from Artifactory. See the Download Locations page."
)
.setGroups(DetectGroup.IAC_SCAN, DetectGroup.GLOBAL)
.build();
@@ -2094,7 +2094,7 @@ private DetectProperties() {
.setInfo("Yarn Exclude Workspaces", DetectPropertyFromVersion.VERSION_7_0_0)
.setHelp(
"A comma-separated list of Yarn workspaces (specified by the workspace directory's relative path) to exclude.",
- "By default, Detect includes all workspaces, but will skip any Yarn workspaces specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "By default, Detect includes all workspaces, but will skip any Yarn workspaces specified via this property. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.YARN, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -2106,7 +2106,7 @@ private DetectProperties() {
.setInfo("Yarn Include Workspaces", DetectPropertyFromVersion.VERSION_7_0_0)
.setHelp(
"A comma-separated list of Yarn workspaces (specified by the workspace directory's relative path) to include.",
- "By default, Detect includes all workspaces. If workspaces are excluded or included, Detect will include any workspace included by this property that is not excluded. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
+ "By default, Detect includes all workspaces. If workspaces are excluded or included, Detect will include any workspace included by this property that is not excluded. Exclusion rules always win. This property accepts filename globbing-style wildcards. For more information, refer to the Property wildcard support page."
)
.setGroups(DetectGroup.YARN, DetectGroup.SOURCE_SCAN)
.setCategory(DetectCategory.Advanced)
@@ -2179,7 +2179,7 @@ private DetectProperties() {
.setInfo("Rapid Compare Mode", DetectPropertyFromVersion.VERSION_7_12_0)
.setHelp(
"Controls how Rapid Scan evaluates policy rules.",
- "Sets the compare mode of Rapid Scan. A setting of ALL evaluates all RAPID or FULL policies. BOM_COMPARE_STRICT shows policy violations not present in a project version BOM that exists in Black Duck SCA. BOM_COMPARE depends on the type of policy rule modes and behaves like ALL if the policy rule is only RAPID and like BOM_COMPARE_STRICT when the policy rule is RAPID and FULL. For further explanation, refer to Rapid Scan."
+ "Sets the compare mode of Rapid Scan. A setting of ALL evaluates all RAPID or FULL policies. BOM_COMPARE_STRICT shows policy violations not present in a project version BOM that exists in Black Duck SCA. BOM_COMPARE depends on the type of policy rule modes and behaves like ALL if the policy rule is only RAPID and like BOM_COMPARE_STRICT when the policy rule is RAPID and FULL. For further explanation, refer to Rapid Scan."
)
.setGroups(DetectGroup.RAPID_SCAN, DetectGroup.BLACKDUCK_SERVER, DetectGroup.BLACKDUCK, DetectGroup.GLOBAL)
.setCategory(DetectCategory.Advanced)
diff --git a/src/main/resources/doc/docPointingToConfluence/markdown/index.md b/src/main/resources/doc/docPointingToConfluence/markdown/index.md
index c5f669c4a2..f6f1212f6e 100644
--- a/src/main/resources/doc/docPointingToConfluence/markdown/index.md
+++ b/src/main/resources/doc/docPointingToConfluence/markdown/index.md
@@ -1,3 +1,3 @@
# Documentation
-The Black Duck Detect documentation is located [here](https://documentation.blackduck.com/bundle/detect/page/introduction.html).
+The Black Duck Detect documentation is located [here](https://docs.blackduck.com/r/detect/latest/black-duck-detect/introduction-to-black-duck-detect.html).