Merge pull request #1294 from blackducksoftware/cp_JenkinsRenaming

Jenkins plugin renaming for BD

Author: cpottsbd

documentation/src/main/markdown/currentreleasenotes.md

@@ -22,4 +22,4 @@
 ### Resolved issues
 
 * (IDETECT-4517) - [detect_product_short] now correctly indicates a timeout failure occurred when multipart binary or container scans timeout during an upload.
-* (IDETECT-4540) - multipart binary and container scans now correctly retry when authentication errors are received during transmission.
+* (IDETECT-4540) - Multipart binary and container scans now correctly retry when authentication errors are received during transmission.

documentation/src/main/markdown/integrations/jenkinsplugin/airgapfordetect.md

@@ -1,5 +1,5 @@
 # Jenkins Air Gap mode
-The [company_name] for Jenkins plugin enables you to configure an Air Gap option to run [detect_product_short]. 
+The [detect_product_long] for Jenkins plugin enables you to configure an Air Gap option to run [detect_product_short]. 
 
 Before you can see the [detect_product_short] Air Gap option on the Global Tool Configuration page, you must install the [detect_product_short] plugin.
 

documentation/src/main/markdown/integrations/jenkinsplugin/autoescapingparameters.md

@@ -1,6 +1,6 @@
 # Auto-escaping Parameters
 
-In [company_name] [detect_product_short] for Jenkins, several special parameters are automatically escaped. 
+In [detect_product_long] for Jenkins, several special parameters are automatically escaped. 
 The workflows pertaining to quotation marks and spaces are as follows.
 
 - Detect properties must be separated by spaces or carriage returns/line feeds.
@@ -13,9 +13,9 @@ The workflows pertaining to quotation marks and spaces are as follows.
 You can turn off auto escaping by setting the environment variable *DETECT\_PLUGIN\_ESCAPING* to false.
 Jenkins enables you to set an environment variable at different levels, such as globally or on a per-job basis. If you set the environment variable globally to one value, you can set it at the job level to another value. It is recommended to set the environment variable globally to skip escaping (ensuring past jobs work as expected), and then if you want to make jobs with the auto escaping enabled, you modify the environment variable flag in that job's configuration to enable escaping the characters. The easiest way to accomplish this is to install the ["Environment Injector" Jenkins plugin](https://plugins.jenkins.io/envinject/).
 
-**Note:** In [company_name] [detect_product_short] plugin version 9, the above recommendations remain the same for agents on Windows systems.  For those agents running on 'NIX systems, *DETECT\_PLUGIN\_ESCAPING* should be set to false.  Ensure that you adhere to the quoting conventions described above. Any input with spaces in the Jenkins configuration should be enclosed in quotes.
+**Note:** In [detect_product_long] plugin version 10, the above recommendations remain the same for agents on Windows systems.  For those agents running on 'NIX systems, *DETECT\_PLUGIN\_ESCAPING* should be set to false.  Ensure that you adhere to the quoting conventions described above. Any input with spaces in the Jenkins configuration should be enclosed in quotes.
 
-[company_name] [detect_product_short] for Jenkins allows some special characters when *DETECT\_PLUGIN\_ESCAPING* is set to false, and spaces can be included without escape sequences provided that they are enclosed in single or double quotes as described above for different agents. Therefore, instead of `My\ Test\ Project1`, you can pass it as `'My Test Project1'`, the project will be created and uploaded to [bd_product_short] as `My Test Project1*.*`
+[detect_product_long] for Jenkins allows some special characters when *DETECT\_PLUGIN\_ESCAPING* is set to false, and spaces can be included without escape sequences provided that they are enclosed in single or double quotes as described above for different agents. Therefore, instead of `My\ Test\ Project1`, you can pass it as `'My Test Project1'`, the project will be created and uploaded to [bd_product_short] as `My Test Project1*.*`
 
 If *DETECT\_PLUGIN\_ESCAPING* is set to true, then you can use backtick (\`) to escape spaces which are passed within argument values. Therefore, you can pass values as "Windows` Project" in the arguments.
 

documentation/src/main/markdown/integrations/jenkinsplugin/configuringtheplugin.md

@@ -1,5 +1,5 @@
 # Configuring the Jenkins Plugin
-Use the following process to configure the [company_name] [detect_product_short] for Jenkins plugin.  Note that the supported credential formats are user name and password or API token.  SAML is not supported.
+Use the following process to configure the [detect_product_long] for Jenkins plugin.  Note that the supported credential formats are user name and password or API token.  SAML is not supported.
 
 1. After installing, navigate to **Manage Jenkins** > **Configure System**.
 1. Navigate to the **[detect_product_short]** section, and complete the following.

documentation/src/main/markdown/integrations/jenkinsplugin/dockercontainers.md

@@ -1,5 +1,5 @@
 # Using Docker Containers - Best Practice
-When running [company_name] [detect_product_short] for Jenkins using the *DETECT\_JAR* environment variable in a pipeline that has a Docker agent, remember to mount the Detect JAR as a volume.
+When running [detect_product_short] for Jenkins using the *DETECT\_JAR* environment variable in a pipeline that has a Docker agent, remember to mount the Detect JAR as a volume.
 
 For example, if you've installed the jar on a node, the JAR won't be accessible from your docker agent unless you either put it somewhere you regularly
 include, or if you mount the path to the jar. Refer to [Docker documentation](https://docs.docker.com/storage/bind-mounts/#choose-the--v-or---mount-flag) for more information.
@@ -18,4 +18,4 @@ pipeline {
 ...
 ```
 
-Applies when running [company_name] [detect_product_short] for Jenkins with a local JAR (which requires setting the *DETECT\_JAR* environment variable).
+Applies when running [detect_product_short] for Jenkins with a local JAR (which requires setting the *DETECT\_JAR* environment variable).

documentation/src/main/markdown/integrations/jenkinsplugin/downloadingandinstalling.md

@@ -1,26 +1,50 @@
 # Downloading, Installing, and Updating the Plugin
-To install the [company_name] [detect_product_short] for Jenkins plugin, perform the following steps:
 
-1. Navigate to **Manage Jenkins** > **Manage Plugins**.
-1. Select the **Available** tab.  (Note that if the plugin is already installed, it does not appear in the **Available** list.)
-1. Select **Blackduck Detect**.
-1. Click **Download now and install after restart**. This is the recommendation for installing the plugin.
-1. After restarting Jenkins, confirm that the plugin is successfully installed by navigating to **Manage Jenkins** > **Manage Plugins > Installed**, and verify that **[company_name] [solution_name]** displays in the list.
+## Downloading and Installing
+To install the [detect_product_short] for Jenkins plugin, perform the following steps:
 
-[company_name] [detect_product_short] plugin for Jenkins GitHub page [jenkinsci](https://github.com/jenkinsci/synopsys-detect-plugin).
-Additional download locations listed in [Download locations](../../downloadingandrunning/downloadlocations.html).
-
-## Updating the [company_name] [detect_product_short] for Jenkins plugin
-You can update the [company_name] [detect_product_short] for Jenkins plugin when new versions are released.
+1. Navigate to **Manage Jenkins** > **Manage Plugins**.
+1. Select the **Available** tab. (Note that if the plugin is already installed, it does not appear in the **Available** list.)
+1. Select **Blackduck [detect_product_short]**.
+1. Click **Download now and install after restart**. This is the recommendation for installing the plugin.
+1. After restarting Jenkins, confirm that the plugin is successfully installed by navigating to **Manage Jenkins** > **Manage Plugins > Installed**, and verify that **[company_name] [solution_name]** displays in the list.
 
-**To update the Jenkins plugin:**
+[detect_product_short] plugin for Jenkins GitHub page [jenkinsci](https://github.com/jenkinsci/blackduck-detect-plugin).
+Additional download locations listed in [Download locations](../../downloadingandrunning/downloadlocations.html).
 
-1. Navigate to **Manage Jenkins** > **Manage Plugins**.
-1. Click the **Updates** tab.
-1. Select **Blackduck Detect**
-   1. If there are updates for the [company_name] [detect_product_short] for Jenkins plugin, the updates display in the list.  If there is not an available update, the [company_name] [detect_product_short] for Jenkins plugin does not display in this list.
-   1. Alternatively, you can force Jenkins to check for plugin updates by clicking **Check now** on the **Updates** tab.
-1. If there are updates, select the one you want, and click **Download now and install after restart**.
+## [company_name] [solution_name] Jenkins plugin to [detect_product_long] Jenkins plugin{#updating-existing-jenkins}
+For existing [company_name] [solution_name] Jenkins plugin 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 take note of your existing system configuration and post-build setup.   
+   * Configuration information can be located under your `JENKINS_HOME` directory.   
+* If you are utilizing a [detect_product_short] Post Build Step, before upgrading to the [detect_product_long] plugin, make sure to record the current configuration set in the configurable pipelines.
+   * For Groovy, you will need to update the **Pipeline** script; under **Pipelines** > **Pipeline_Name** > **Configuration**, replacing the `synopsys_detect detectProperties:` portion of the script with `blackduck_detect detectProperties:`
+   
+   Example:
+```
+   node ('built-in') {
+
+    stage ('Git - Checkout') {
+    git 'https://github.com/yarnpkg/example-yarn-package.git'
+    }
+    stage ('Black Duck - Detect') {
+    blackduck_detect detectProperties: '--blackduck.trust.cert=true --detect.wait.for.results=true', downloadStrategyOverride: [$class: 'ScriptOrJarDownloadStrategy']
+        
+    }
+}
+```
+   
+* For the System Configuration and [bd_product_long], before upgrading to the [detect_product_long] plugin, make sure to back up, or record the current configuration set for the [bd_product_short] URL and token that you have set in Manage Jenkins > Configure System > [detect_product_long] section.
+* If you are using Air Gap mode, before upgrading to the [detect_product_long] plugin, make sure to save the current tool configuration that you have set in Manage Jenkins > Tools > Detect Air Gap mode.
+
+## Updating the [detect_product_long] for Jenkins plugin
+You can update the [detect_product_short] for Jenkins plugin when new versions are released.
+
+1. Navigate to **Manage Jenkins** > **Manage Plugins**.
+1. Click the **Updates** tab.
+1. Select **Blackduck Detect**
+   1. If there are updates for the [detect_product_short] for Jenkins plugin, the updates display in the list. If there is not an available update, the [detect_product_short] for Jenkins plugin does not display in this list.
+   1. Alternatively, you can force Jenkins to check for plugin updates by clicking **Check now** on the **Updates** tab.
+1. If there are updates, select the one you want, and click **Download now and install after restart**.
 
 <!-- Commenting out until the script is updated to support the current releases
 ## Migrating from plugin version 1.5.0

documentation/src/main/markdown/integrations/jenkinsplugin/images/Pipeline1.png

@@ -1,6 +1,6 @@
 # Jenkins Plugin
 
-The [company_name] [detect_product_short] for Jenkins plugin enables you to install and run [detect_product_short] in your Jenkins instance. 
+The [detect_product_short] for Jenkins plugin enables you to install and run [detect_product_short] in your Jenkins instance. 
 
 [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.
 

documentation/src/main/markdown/integrations/jenkinsplugin/images/Pipeline2.png

@@ -1,8 +1,8 @@
 # Requirements for [detect_product_short] for Jenkins
 
-Requirements for [company_name] [detect_product_short] for Jenkins which may be in addition to those for [detect_product_short].
+Requirements for [detect_product_short] for Jenkins which may be in addition to those for [detect_product_short].
 
 * Access to the internet is required to download components from GitHub and other locations.
 * Minimum 8GB RAM.
 * Java: OpenJDK 64-bit version 8, 11, 13, 14, 15, 16, or 17. If using Java 11: 11.0.5 or higher is required.
-* Jenkins minimum version of 2.401.3.
+* Jenkins minimum version of 2.426.3.

documentation/src/main/markdown/integrations/jenkinsplugin/jenkins.md

@@ -1,5 +1,32 @@
 # Release Notes for Jenkins 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 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.
+
+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)
+
+<note type="note">For continued functionality and to receive future updates to the Jenkins plugin, you must upgrade to [detect_product_long] Jenkins plugin version 10.0.0 prior to February 14th, 2025.</note>
+
+If you are a new user, you may proceed with installing the [detect_product_long] Jenkins plugin as per [Downloading and Installing](../jenkinsplugin/downloadingandinstalling.md).    
+
+**Changed features**
+
+* (IDTCTJNKNS-277) Updated to use the new 'blackduck' namespace.
+* Updated to use [detect_product_long] 10.x.x for execution.
+* Jenkins version 2.426.3 or later is required.
+
+**Resolved issues**
+
+* The plugin has been built against upgraded Jenkins/Jenkins plugin versions to mitigate known security risks.
+
 ## **Version 9.0.0**
 **New features**
 

documentation/src/main/markdown/integrations/jenkinsplugin/jenkinsrequirements.md

@@ -1,6 +1,6 @@
-# Running [detect_product_short] in Jenkins
+# Running [detect_product_long] in Jenkins
 
-By default, [company_name] [detect_product_short] for Jenkins downloads either the latest [detect_product_short] shell script when run on a UNIX node, or PowerShell script when it's run on a Windows node, to the Jenkins tools directory, and then executes that script. Note that you can also use the JAR option to run [detect_product_short].
+By default, [detect_product_short] for Jenkins downloads either the latest [detect_product_short] shell script when run on a UNIX node, or PowerShell script when it's run on a Windows node, to the Jenkins tools directory, and then executes that script. Note that you can also use the JAR option to run [detect_product_short].
 
 The [detect_product_short] PowerShell or shell script is downloaded once and placed in the [detect_product_short] working directory. If you want to force the plugin to fetch the latest script, clear out the Detect directory in your Jenkins tools directory.
 
@@ -33,4 +33,4 @@ Refer to the [freestyle example](../../integrations/jenkinsplugin/jenkinsfreest
 ## DSL considerations
 The [detect_product_short] for Jenkins plugin provides Dynamic DSL for both freestyle steps and pipeline steps. Read more at [Dynamic DSL](https://github.com/jenkinsci/job-dsl-plugin/wiki/Dynamic-DSL).
 
-**Note:** that versions 1.72 and later of the DSL plugin do not support the [company_name] [detect_product_short] for Jenkins plugin pipeline steps.
+**Note:** that versions 1.83 and later of the DSL plugin do not support the [detect_product_short] for Jenkins plugin pipeline steps.