build-scan

Full build scan — installs Node.js dependencies and runs a comprehensive Black Duck SCA intelligent scan.

Overview

This example demonstrates a complete Black Duck SCA scan that includes a build step. The workflow:

1. Checks out the source code
2. Sets up Node.js and installs all dependencies via npm install
3. Runs a full Black Duck SCA intelligent scan

Including the build step allows Black Duck to accurately identify all transitive dependencies from the resolved dependency tree.

Workflow File

.github/workflows/build-scan.yml

Key Parameters

Parameter	Value	Description
blackduck_url	${{ secrets.BLACKDUCK_URL }}	URL of your Black Duck instance
blackduck_apiToken	${{ secrets.BLACKDUCK_API_TOKEN }}	API token for authentication
blackduck_scan_full	true	Runs a full intelligent scan using build artifacts

Prerequisites

• A Black Duck instance (SaaS or on-prem)
• GitHub repository secrets configured:
  • BLACKDUCK_URL — URL of your Black Duck instance (e.g., https://blackduck.example.com)
  • BLACKDUCK_API_TOKEN — API token with scan permissions

Usage

1. Copy .github/workflows/build-scan.yml into your repository's .github/workflows/ directory
2. Configure the required secrets under Settings → Secrets and variables → Actions
3. Push to main or open a pull request to trigger the scan

When to Use This Example

• Your project has a build step that resolves and downloads dependencies
• You want the most accurate and comprehensive scan results
• You are scanning on push to main as part of a full CI pipeline

Navigation

← Back to Black Duck SCA Samples