Microsoft Azure DevOps Server (UA) Integration

Overview

This topic describes how to run the Unified Agent from within Microsoft Azure DevOps Server (previously Team Foundation Server).

Prerequisites 

  1. Download and install the Java JRE/JDK. See the Unified Agent prerequisites for supported Java versions.

  2. Set your JAVA_HOME system variable to the relevant Java version (see version in the previous step).

  3. Ensure you have the Team Foundation Server 2018 Update 2 or a later version. 

Integrating Microsoft Azure DevOps Server

  1. Open a browser and navigate to your Azure DevOps Server / TFS (for example: http://SERVER_NAME:8080/tfs/DefaultCollection).

  2. Create a new project or open an existing one. Make sure your project has a valid repository.

  3. Download the TFS agent (If you haven't already). To download the agent, do the following:

    1. Go to your project settings and select Agent Queues.

    2. Click Download agent and follow the instructions for setting up the agent and running it.

    3. You should have an agent running at this step.

  4. Go to Build and Release.

  5. Click on New definition or select an existing definition.

    1. For a new definition, select a relevant source, click Continue, then create an Empty process.

  6. Go to your Tasks.

  7. Add a new Task:

    1. Search for Command Line.

    2. Click on Add next to the task.

    3. Click on the task from the left-hand section. Enter Run curl jar in the Display name field.

    4. Enter curl in the Tool field.

      NOTICE ON CURL USAGE: It is advised to use the curl command 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 cron.

    5. Enter -LJO https://github.com/whitesource/unified-agent-distribution/releases/latest/download/wss-unified-agent.jar in the Arguments field.

  8. Copy the above task by right clicking on it, and then click on Clone task(s).

    1. Click on the task from the left-hand section and enter Run curl config in the Display name field.

    2. Enter curl in the Tool field.

    3. Enter -LJO https://github.com/whitesource/unified-agent-distribution/raw/master/standAlone/wss-unified-agent.config in the Arguments field. 

  9. Copy the above task by right clicking on it, and click on Clone task(s).

    1. Click the task from the left-hand section and enter Run FSA in the Display name field.

    2. Enter java in the Tool field.

    3. Enter -jar wss-unified-agent.jar -c wss-unified-agent.config -apiKey YOUR_WHITESOURCE_API_KEY -project PROJECT_NAME in the Arguments field.

  10. Click on Save & queue.