Whitesource Scan Using Unified Agent

A Github action which uses the Whitesource Unified Agent to scan a given repository.

Description

This Action will auto-resolve dependencies, so no configuration file is required (unless specified).

This action offers a quick scan of a repository with minimal configuration.
- For more advanced use, please include a config file. (See usage below)
- If you need to perform some commands beforehand, please also include the path to the script file.
- Please raise an issue for a specific request e.g. alternative configuration. I will update this over time.

For Details Unified Agent configuration, please see the page Unified Agent Configuration File and Parameters

Usage

Example Usage (Quick Setup without Config File)

Uses the Auto Resolve Dependencies flag. You must have the Whitesource API key set in your Github secrets.

name: Whitesource Security Scan Example

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Run Whitesource Action
      uses: adracea/universalws@v0.1
      with:
        wssUrl: https://app-eu.whitesourcesoftware.com/agent
        apiKey: ${{ secrets.WSS_API_KEY }}
        productName: 'Microservices'
        projectName: 'My-Example-Microservice'

Example Usage (With Config File and optionally install file)

name: Whitesource Security Scan Example

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Run Whitesource Action
      uses: adracea/universalws@v0.1
      with:
        wssUrl: https://app-eu.whitesourcesoftware.com/agent
        apiKey: ${{ secrets.WSS_API_KEY }}
        agentConfig: 'whitesource-fs-agent.config'
        preRunFile: 'install_commands.sh' # Optional Extra

Parameter reference

Inputs

Input	Description	Required?	Type	Default Value
`wssURL`	The relevent URL to your org's WS Server.	yes	`string`	-
`apiKey`	API key from Whitesource.	yes	`string`	-
`productName`	Name of the Product that this project falls under	no	`string`	My Product
`projectName`	Name of the Project. Repository name if not set.	no	`string`	{Repository Name}
`agentConfig`	Filename of whitesource configuration (including file path)	no	`string`	-
`preRunFile`	Filename of a file to run before the scan begins.	no	`string`	-
`failOnPolicyViolations`	Enables policy violations, fails build if violations found.	no	`string`	false