The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Black Duck Hub Plugin for Jenkins

hub_scan: Black Duck Hub Integration

  • scans
      Array/List
      Nested Object
    • scanTarget
      • Type: String
  • hubProjectName
    Provide the name of the Hub project that you would like to link these scans to.
    • Type: String
  • hubProjectVersion
    Provide the Version of the Hub project that you would like to link these scans to.
    • Type: String
  • hubVersionPhase
    Choose the Phase at which this Version is in its life cycle.
    • Type: String
  • hubVersionDist
    Choose how this Version is planned to be distributed.
    • Type: String
  • scanMemory
    Specify the memory, in megabytes, you would like to allocate for the BlackDuck Scan. Default: 4096
    • Type: String
  • shouldGenerateHubReport
    • Type: boolean
  • projectLevelAdjustments
    Always maintain component adjustments to all versions of this project.
    • Type: boolean
  • bomUpdateMaximumWaitTime
    Maximum time to wait (in minutes) for the BOM to be updated with the scan results.
    This also gets used as the maximum time to wait for the Report to be generated.
    Default: 5 minutes
    • Type: String
  • dryRun
    If checked, the scan results will be put in a json file within the log directory in /data/
    When running a dry run the Report generation and Failure Conditions will be skipped.
    • Type: boolean
  • cleanupOnSuccessfulScan
    If checked, then the plugin will delete the log files produced by the CLI if the scan is successful.
    • Type: boolean
  • excludePatterns
      Array/List
      Nested Object
    • exclusionPattern
      • Type: String
  • codeLocationName
    This will change the name of the Code Location that is created by this scan.
    An example of a consistent Code Location across nodes and builds would be ${JENKINS_URL}-${JOB_NAME}
    WARNING: This will only work with a single target specified.
    • Type: String
  • unmapPreviousCodeLocations
    Any Code Locations that were not part of the current scan, and are mapped to this Project and Version, will be unmapped from this Version.
    • Type: boolean
  • deletePreviousCodeLocations
    Any Code Locations that were not part of the current scan, and are mapped to this Project and Version, will be deleted.
    • Type: boolean

hub_scan_failure: Black Duck Hub Failure Conditions (Hub 3.0+)

  • failBuildForPolicyViolations
    This will check the the Version of the Project specified to see if any of the BOM entries violate policies defined in the Hub.
    If there are BOM entries that do violate Policies, the Build will be set to FAILURE
    • Type: boolean
  • buildStateOnFailure
    If the Failure Condition is met, then the Build will be set to this state on completion.
    Success = Will not fail the Build
    Unstable = Will set the Build Result to Unstable
    Failure = Will set the Build Result to Failure
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.