Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Download CURL, add it to your PATH environment variable.

  2. Restart Jenkins in order for it to load the new PATH variable.

  3. In the 'Pipeline' select 'Definition: Pipeline script', and add the following lines to the script:

    NOTE: It is advised to use the below curl commands only once a week to download the latest version of the Unified Agent for performance reasons and not as part of every build. You can do this using a scheduler task, such as corn.

    Code Block
    node {
      stage('Download WS Script') {
       bat 'curl -LJO https://github.com/whitesource/unified-agent-distribution/raw/master/standAlone/wss_agent.sh'
      }
      stage('Run WS Script') {
        bat 'wss_agent.sh -apiKey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx -c [path to config file] -project my-project -d [path to folder to scan]' 
      }
    }

...

In the 'Pipeline', select 'Definition: Pipeline script', and add the following lines to the script:

...

  1. Download CURL, add it to your PATH environment variable.

  2. Restart Jenkins in order for it to load the new PATH variable.

  3. Go to 'Build', click on 'Add build step" and then select 'Execute Windows batch command' or 'Run with timeout'.

  4. Add the following commands on the new 'Command' window:

    Code Block
    curl -LJO https://github.com/whitesource/unified-agent-distribution/raw/master/standAlone/wss_agent.sh
    wss_agent.sh -apiKey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx -c [path to config file] -project my-project -d [path to folder to scan]

...

Free Style Job on Windows Using PowerShell

  1. Go to 'Build', click on 'Add build step' and then select 'Execute Windows batch command' or 'Run with timeout'.

  2. Add the following commands:

    Code Block
    powershell bitsadmin /transfer mydownload /dynamic /download /priority FOREGROUND https://github.com/whitesource/unified-agent-distribution/releases/latest/download/wss-unified-agent.jar $pwd\wss-unified-agent.jar 
    powershell bitsadmin /transfer mydownload /dynamic /download /priority FOREGROUND https://github.com/whitesource/unified-agent-distribution/raw/master/standAlone/wss-unified-agent.config $pwd\wss-unified-agent.config 
    java -jar wss-unified-agent.jar -apiKey xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx -c [path to config file] -project my-project -d [path to folder to scan]
  3. Note the following:

    • The first command downloads the latest version of WhiteSource Unified Agent JAR jar file to the job folder.

    • The second command downloads the latest version of the WhiteSource Unified Agent configuration file to the job folder.

    • The third command runs the JAR with the command line arguments of the Unified Agent.

    • Make sure to edit the Unified Agent configuration file to match your requirements.

    • Make sure that Background Intelligent Transfer Service (BITS) is enabled on the node that is running the job.

Pipeline Job on Linux/Unix

In the 'Pipeline' select 'Definition: Pipeline script', and add the following lines to the script:

...

  • The first command downloads the 'wss_agent.sh' script file to the job folder.

  • The second command runs the script 'wss_agent.sh'. This script downloads the latest version of WhiteSource Unified Agent JAR jar file and the configuration file to your Jenkins job workspace.

  • The script runs the JAR with the command line arguments of the Unified Agent.

  • Make sure to edit the Unified Agent configuration file to match your requirements.

  • Make sure that you have the permission to download/execute the 'wss_agent.sh' script.

Free Style Job on Linux/Unix:

Go to 'Build', click on 'Add build step' and then select 'Execute shell' or 'Run with timeout'.
Add the following commands in the new 'Command' window:

...

  • The first command downloads the 'wss_agent.sh' script file to the job folder.

  • The second command runs the script 'wss_agent.sh'. This script downloads the latest version of WhiteSource Unified Agent JAR jar file and the configuration file to your Jenkins job workspace.

  • The script runs the JAR with the command line arguments of the Unified Agent.

  • Make sure to edit the Unified Agent configuration file to match your requirements.

  • Make sure that you have the permission to download/execute the 'wss_agent.sh' script.