Jenkins Plugin

This plugin allows you to build and deploy UiPath automation processes, as well as run UiPath automated test cases.

In order to pack projects created with UiPath Studio starting from 2020.10, you need to use a version starting from 2.1 of this extension.

Important: Starting with April 2023, and 2023.4, new executions will be blocked in classic folders. For tasks that include a classic folder in their configuration, a Folder not found message is displayed, and the task is not performed.

Prerequisites

• Jenkins server running on Windows or Linux.
• At least one Jenkins slave running on Windows (required for step execution).

• Orchestrator instance (basic, federated or cloud authentication are supported).

  • Testing features require Orchestrator version 2020.4 or higher.
  • When using an on-premise Orchestrator under HTTPS, make sure to import the SSL Certificate so that the HTTPS calls to Orchestrator can be trusted.

Installing and Enabling the Plugin

The Jenkins plugin can be installed from any Jenkins installation connected to the internet using the Plugin Manager screen.

Obtaining the Cloud Orchestrator API Key

Configure Service Connection for External Apps

Step 1: Configure your external application and scopes. After adding the application, keep the App ID, Secret and Application Scopes at hand, to be used for the next step.

Note: If you generate and use a new Secret, the old one is going to be invalidated.

Step 2: Configure application credentials as secret text in Jenkins. For this step you need the Secret generated in Automation Cloud™ .

Step 3: Configure the Authentication for each task under Post-Build Actions, by adding the Account Name, followed by the App ID, Secret and Application Scopes generated through Automation Cloud™ .

Note: Consider using the external app in individual pipelines to avoid invalidation errors.

Additional Information

• All paths specified should be local to the current workspace. You can use environment variables in paths, though you should make sure that they result in paths that are local to the workspace.
• To deploy packages or run tests, make sure that the authenticated user has the Folders View (or OrganizationUnits View) and (20.4+ only) Background Tasks View permissions.
• To package libraries, when connected to an Orchestrator instance, make sure that the authenticated user has the Libraries View permission.

• For further details on managing external apps:

  • For cloud Orchestrator - please refer to the official documentation.
  • For on-premise Orchestrator - please refer to the official documentation.