Merge pull request #1301 from blackducksoftware/CP_ADO_Renaming

ADO Plugin renaming and screenshots

Author: cpottsbd

buildSrc/src/main/java/com/blackduck/integration/detect/docs/content/Terms.java

@@ -11,6 +11,7 @@ public Terms() {
         termMap.put("script_repo_url_bash", "https://detect.blackduck.com/detect10.sh");
         termMap.put("script_repo_url_powershell", "https://detect.blackduck.com/detect10.ps1");
         termMap.put("binary_repo_url_project", "https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/");
+        termMap.put("binary_repo_url_project_old", "https://repo.blackduck.com/bds-integrations-release/com/synopsys/integration/synopsys-detect/");
         termMap.put("binary_repo_ui_url_project", "https://repo.blackduck.com/bds-integrations-release/com/blackduck/integration/detect/");
         //No UI for repo.blackduck.com as of 2024-09-25
         termMap.put("binary_repo_jenkins_url_project", "https://repo.blackduck.com/bds-integrations-release/com/blackducksoftware/integration/blackduck-detect/");

documentation/src/main/markdown/integrations/azureplugin/azure.md

@@ -11,15 +11,23 @@ As a [detect_product_short] and Azure DevOps user, [detect_product_short] Extens
 
 Using the [detect_product_short] Extension for Azure DevOps together with [bd_product_short] enables you to use Azure DevOps to automatically create [bd_product_short] projects from your Azure DevOps projects.
 
-**Note:** The Azure plugin currently supports [detect_product_short] 9.X.
+<note type="Note">The Azure plugin currently supports [detect_product_short] 9.x or greater.</note>
+
+
+   <figure>
+    <img src="../azureplugin/images/bd-extension.png"
+         alt="Plugin">
+    <figcaption>Plugin</figcaption>
+</figure>
+
 
 ## Invoking [detect_product_short]
 It is recommended to invoke [detect_product_short] from the CI (build) pipeline. Scanning during CI enables [detect_product_short] to break your application build, which is effective for enforcing policies like preventing the use of disallowed or vulnerable components.
 
    <figure>
     <img src="../azureplugin/images/introscreen.png"
          alt="Intro">
-    <figcaption>Intro screen</figcaption>
+    <figcaption>ADO Tasks screen</figcaption>
 </figure>
 
 ## Basic workflow

documentation/src/main/markdown/integrations/azureplugin/azurepluginreleasenotes.md

@@ -1,10 +1,44 @@
 # Release Notes for Azure DevOps Plugin
 
+## Version 10.0.0
+**Notice**
+
+The [company_name] Software Integrity Group is now [var_company_name]    
+* As part of this activity, sig-repo.synopsys.com and detect.synopsys.com are being deprecated and will be decomissioned on Feb. 14th 2025. Please make use of repo.blackduck.com and detect.blackduck.com respectively.    
+* Refer to the [Black Duck Domain Change FAQ](https://community.blackduck.com/s/article/Black-Duck-Domain-Change-FAQ#SDInstru).
+<note type="note">It is recommended that customers add both `repo.blackduck.com`, and `detect.blackduck.com`, to their allow list, while also maintaining `sig-repo.synopsys.com`, and `detect.synopsys.com`, until February 2025 when `sig-repo.synopsys.com`, and `detect.synopsys.com`, will be fully replaced by `repo.blackduck.com` and `detect.blackduck.com` respectively.</note>
+* [company_name] [solution_name] Azure DevOps plugin is now the [detect_product_long] Azure DevOps plugin.
+.
+### Migrating from [company_name] [detect_product_short] plugin to [detect_product_long] plugin
+* **Before** moving to the [detect_product_long] plugin, you must manually uninstall the [company_name] [detect_product_short] plugin. 
+	* Installing the [detect_product_long] plugin will ensure you receive future plugin updates.   
+
+* After uninstalling a previous [company_name] [detect_product_short] plugin or if you are a new user, you may proceed with installing the [detect_product_long] plugin available at the following [Marketplace location](https://marketplace.visualstudio.com/items?itemName=blackduck.blackduck-detect).    
+	* See the [detect_product_long] plugin [installation instructions](../azureplugin/installingtheplugin.md).    
+
+**New features**
+
+* Plugin updated to support [detect_product_long] 10.
+	* [detect_product_long] [Release Notes](../../currentreleasenotes.md)
+
+## Version 9.0.1
+
+**Notice**
+
+For [detect_product_short] script downloads, `detect.synopsys.com` is being deprecated in favor of `detect.blackduck.com`. After Feb. 14th 2025, only `detect.blackduck.com` will be available.
+
+<note type="attention">To continuing using the deprecated [company_name] [detect_product_short] plugin, it is essential to update to version 9.0.1, available at the [Previous Marketplace location](https://marketplace.visualstudio.com/items?itemName=synopsys-detect.synopsys-detect), before Feb. 14th 2025.</note>
+**Changed features**
+
+* Adds logic to fallback between pulling the [detect_product_short] script from `detect.synopys.com` and `detect.blackduck.com`.
+
+<note type="note">It is recommended that customers add both `repo.blackduck.com`, and `detect.blackduck.com`, to their allow list, while also maintaining `sig-repo.synopsys.com`, and `detect.synopsys.com`, until February 2025 when `sig-repo.synopsys.com`, and `detect.synopsys.com`, will be fully replaced by `repo.blackduck.com` and `detect.blackduck.com` respectively.</note>
+
 ## Version 9.0.0
 **New features**
 
 * Updated the plugin to use [company_name] [solution_name] 9.   
-	* [company_name] [solution_name] [Release Note](../../currentreleasenotes.md)
+	* [company_name] [solution_name] [Release Notes](../../currentreleasenotes.md)
 
 **Resolved issues**
 

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://synopsys.atlassian.net/wiki/spaces/INTDOCS/pages/177799187/Black+Duck+Release+Compatibility).
+  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).
 * [bd_product_short] API token to use with Azure.
 * Azure DevOps Services or Azure DevOps Server 17 or later
 * Java.
@@ -12,6 +12,7 @@ The following is a list of requirements for the [detect_product_long] in Azure D
 
 The [detect_product_short] plugin for Azure DevOps is supported on the same operating systems and browsers as [bd_product_short].
 
-For scanning NuGet projects, verify that you have the NuGet tool installer set up in the build job definition.  For further information see [NuGet tool](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/tool/nuget?view=azure-devops&viewFallbackFrom=vsts%3Fview%3Dvsts)
+For scanning NuGet projects, verify that you have the NuGet tool installer set up in the build job definition.
+For further information see [NuGet tool](https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/tool/nuget?view=azure-devops&viewFallbackFrom=vsts%3Fview%3Dvsts)
 
-You can get the [detect_product_short] for Azure DevOps plugin at [VisualStudio Marketplace](https://marketplace.visualstudio.com/items?itemName=synopsys-detect.synopsys-detect).
+You can get the [detect_product_short] for Azure DevOps plugin at the [VisualStudio Marketplace](https://marketplace.visualstudio.com/items?itemName=blackduck.blackduck-detect).

documentation/src/main/markdown/integrations/azureplugin/configuringandrunning.md

@@ -11,27 +11,28 @@ Configure your [detect_product_long] for Azure DevOps plugin by adding configura
 
 ## Configuring the plugin
 
-1. Navigate to **Your Collection > Project > Pipelines > Tasks**. The plugin adds a new task of **Run [company_name] [solution_name] for your build**. 
-   You must add this task to your build queue. 
-1. Click **Run [detect_product_short] for your build**, and the **[detect_product_short]** panel displays on the right. In the **[detect_product_short]** configuration panel, complete the following fields and options.
-1. **Display name:** Type a unique name in this field.  Note that the name you type here displays in the left panel; the default name is **Run [detect_product_short] for your build**.
-1. Click **+ New** to add a new **[bd_product_short] Service Endpoint** and then configure the details.
-1. Click **+ New** to add a new **[bd_product_short] Proxy Service Endpoint** and then configure the details.
-1. **Detect Version**: Version of the [detect_product_short] binary to use. Synopsys recommends using the latest but you can specify a version override if desired.
-1. **Detect Run Mode:** Select the run mode. If you select Use Airgap Mode, a [detect_product_short] Air Gap Jar Directory Path field opens in which you must specify the [detect_product_short] Air Gap Jar Path.
-1. **Detect Arguments**: Here you can include additional [detect_product_short]* arguments; [detect_product_short] picks up your build environment variables and your project variables. Use a new line or space to separate multiple arguments. Use double quotes to escape. You can use environment and build variables.
+1. Navigate to **Your Collection > Project > Pipelines > Tasks**. The plugin adds a new task of **Run [detect_product_long] for your build**.
+   You must add this task to your build queue.
+1. Click **Run [detect_product_short] for your build**, and the **[detect_product_short]** panel displays on the right. In the **[detect_product_short]** configuration panel, complete the following fields and options.
+1. **Display name:** Type a unique name in this field. Note that the name you type here displays in the left panel; the default name is **Run [detect_product_short] for your build**.
+1. Click **+ New** to add a new **[bd_product_short] Service Endpoint** and then configure the details.
+1. Click **+ New** to add a new **[bd_product_short] Proxy Service Endpoint** and then configure the details.
+1. **[detect_product_short] Version**: Version of the [detect_product_short] binary to use. It is recommended to use the latest, but you can specify a version override if desired.
+1. **[detect_product_short] Run Mode:** Select the run mode. If you select Use Airgap Mode, a [detect_product_short] Air Gap Jar Directory Path field opens in which you must specify the [detect_product_short] Air Gap Jar Path.
+1. **[detect_product_short] Arguments**: Here you can include additional [detect_product_short]* arguments; [detect_product_short] picks up your build environment variables and your project variables. Use a new line or space to separate multiple arguments. Use double quotes to escape. You can use environment and build variables.
+
 For more information on [detect_product_short] arguments, refer to [Properties](../../properties/configuration/overview.md).
 
-1. **Detect Folder**: The location to download the Detect jar or the location of an existing Detect jar. The default is the system temp directory.  To specify a different directory, type the directory path and name in the field.
+* **[detect_product_short] Folder**: The location to download the [detect_product_short] jar or the location of an existing [detect_product_short] jar. The default is the system temp directory. To specify a different directory, type the directory path and name in the field.
 
-Windows agents require an absolute path when specifying detect download location in the **Detect Folder** field.
+Windows agents require an absolute path when specifying [detect_product_short] download location in the **[detect_product_short] Folder** field.
 
-1. **Add Detect Task Summary**: Click this checkbox to add a summary of the Detect task to the build summary task.
+* **Add [detect_product_short] Task Summary**: Click this checkbox to add a summary of the [detect_product_short] task to the build summary task.
 
 
-In the user interface, fields with a red asterisk ( **\*** ) are required.  Some default values are provided, such as version.
+In the user interface, fields with a red asterisk ( **\*** ) are required. Some default values are provided, such as version.
 
-**Note:** that the following fields belong to Azure DevOps, and are not part of the Detect plugin:
+**Note:** that the following fields belong to Azure DevOps, and are not part of the [detect_product_long] plugin:
 
 - Task version
 - Display name

documentation/src/main/markdown/integrations/azureplugin/configuringbuildagent.md

@@ -3,17 +3,17 @@ To configure a build agent in your pipeline do the following under the **Tasks**
 
 The default option for the build agent is the Microsoft hosted agent. To be able to select a self-hosted agent, you must have installed the agent and ensure that it's available to your project before you can use it in your pipeline. Click the ellipsis (**…**) next to Pipeline to Add an agent job.
 
-1. Click the ellipsis (**…**) next to Pipeline to Add an agent job.
+* Click the ellipsis (**…**) next to Pipeline to Add an agent job.
 
    <figure>
     <img src="../azureplugin/images/configuringagent.png"
          alt="Configuring an Agent">
     <figcaption>Configuring an Agent</figcaption>
 </figure>
 
-1. On the Agent job configuration screen, do the following:
-   1. Select a self-hosted agent from your Agent pool or select Azure Pipelines for an Azure-hosted agent.
-   1. If you select a hosted agent, then you must select an operating system such as macOS, Windows, or a version of Linux for the hosted agent VM.
+* On the Agent job configuration screen, do the following:
+   * Select a self-hosted agent from your Agent pool or select Azure Pipelines for an Azure-hosted agent.
+   * If you select a hosted agent, then you must select an operating system such as macOS, Windows, or a version of Linux for the hosted agent VM.
 
 <note type="tip">This is not an airgap option as internet connections are still required for downloading other tools and the script will still download new content if needed.</note>
 
@@ -25,6 +25,6 @@ You can configure the build agent for [detect_product_short] Azure Plugin to use
 
 ### Proxy configuration scenarios
 
-1. If both an agent proxy and [bd_product_short] Poxy Service Endpoint are set through ADO Plugin parameter, the [bd_product_short] proxy url endpoint takes precedence.
+* If both an agent proxy and [bd_product_short] Poxy Service Endpoint are set through ADO Plugin parameter, the [bd_product_short] proxy url endpoint takes precedence.
 
-2. If agent proxy is configured, and the [bd_product_short] Poxy Service Endpoint is not set through ADO Plugin parameter, the [detect_product_short] Azure Plugin utilizes the agent proxy.
+* If agent proxy is configured, and the [bd_product_short] Poxy Service Endpoint is not set through ADO Plugin parameter, the [detect_product_short] Azure Plugin utilizes the agent proxy.

documentation/src/main/markdown/integrations/azureplugin/images/bd-extension.png

@@ -1,20 +1,22 @@
 # Installing the Azure DevOps plugin
 From the Azure Pipelines page, add the [detect_product_long] plug-in for ADO.
 
-**Install the [detect_product_short] extension for Azure DevOps**
+<note type="note">If you are an existing [detect_product_short] user, manually uninstall the [company_name] [detect_product_short] Plugin and install the [detect_product_long] plugin to receive future updates.</note>
 
-1. Click the plus sign (**+**) under Tasks for Agent Job
-1. Search for the [detect_product_short] plugin and click **Add** to add it to your pipeline.
+**Install the [detect_product_short] extension for Azure DevOps**
 
+* Click the plus sign (**+**) under Tasks for Agent Job
+* Search for the [detect_product_short] plugin and click **Add** to add it to your pipeline.
 
    <figure>
     <img src="../azureplugin/images/installing1.png"
          alt="Adding the plugin">
     <figcaption>Adding the plugin</figcaption>
 </figure>
-
+   
+* Detect now appears as a pipeline option.   
    <figure>
     <img src="../azureplugin/images/installing2.png"
          alt="Pipeline option">
-    <figcaption>Now a pipeline option</figcaption>
+    <figcaption>Pipeline option</figcaption>
 </figure>

documentation/src/main/markdown/integrations/azureplugin/images/configuringagent.png

@@ -1,6 +1,7 @@
 # Running the Task
 After you have configured your task, you can run it as follows:
 
-- In Azure DevOps, click **Queue**, and your task is executed on the next available build agent.
-- If your task configuration is incomplete, a red status message of "*Some settings need your attention*" displays below **Run [detect_product_short] for your build**. Missing required settings display in red in the **[detect_product_short]** panel.
+* In Azure DevOps, click **Queue**, and your task is executed on the next available build agent.
+* If your task configuration is incomplete, a red status message of *Some settings need your attention* displays below **Run [detect_product_short] for your build**.
+   * Missing required settings display in red in the **[detect_product_short]** panel.
 

documentation/src/main/markdown/integrations/azureplugin/images/configuringplugin.png

@@ -8,7 +8,7 @@ The [company_name] Software Integrity Group is now [var_company_name]
 * As part of this activity, sig-repo.synopsys.com and detect.synopsys.com are being deprecated and will be decommissioned in Feb. 2025. Please make use of repo.blackduck.com and detect.blackduck.com respectively.    
 * Refer to the [Black Duck Domain Change FAQ](https://community.blackduck.com/s/article/Black-Duck-Domain-Change-FAQ#SDInstru).
 
-[company_name] [solution_name] Jenkins plugin is now the [detect_product_long] Jenkins plugin.
+* [company_name] [solution_name] Jenkins plugin is now the [detect_product_long] Jenkins plugin.
 
 For existing users, the [detect_product_long] Jenkins plugin should be considered a fresh installation as the domain has changed.
 Before moving from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin, you should record your existing system configuration. See additional information about upgrading from the [detect_product_short] Jenkins plugin to the [detect_product_long] Jenkins plugin under [Downloading and Installing.](../jenkinsplugin/downloadingandinstalling.md#updating-existing-jenkins)

documentation/src/main/markdown/integrations/azureplugin/images/installing1.png

@@ -4,7 +4,9 @@ The following are download locations for the current version of [detect_product_
 
 * [detect_product_short] Bash script: [Bash script](${script_repo_url_bash})
 * The [detect_product_short] PowerShell script: [PowerShell script](${script_repo_url_powershell})
-* The [detect_product_short] binary repository (.jar and air gap zip files): [Binary files](${binary_repo_url_project})
+* Version 10.0.0 and later [detect_product_short] binary repository (.jar and air gap zip files): [Binary files](${binary_repo_url_project})
+* Version 9.10.1 and prior [detect_product_short] binary repository (.jar and air gap zip files): [Binary files](${binary_repo_url_project_old})
+
 * The [detect_product_short] repository for the Jenkins plugin: [Release Artifacts Repository](${binary_repo_jenkins_url_project})
 
 **Note:** For certain types of projects, [detect_product_short] automatically downloads one or more [inspectors](../components/inspectors.md) as needed.