generated from actions/javascript-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add references to UiPath documentation (#89)
Add references to UiPath documentation for notes on compatibility and UiPath CLI capabilities
- Loading branch information
1 parent
4574180
commit dc264b3
Showing
1 changed file
with
9 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,19 @@ | ||
# UiPath CLI Setup Action | ||
A GitHub Action for setting up the UiPath CLI tool available from this link: https://www.myget.org/feed/uipath-dev/package/nuget/UiPath.CLI. | ||
A GitHub Action for setting up the [UiPath CLI](https://docs.uipath.com/test-suite/automation-suite/2022.10/user-guide/uipath-command-line-interface) on GitHub Actions runners. | ||
|
||
**Note: This action is only compatible with Windows runners** | ||
**Note on compatibility:** This action is compatible with both Windows and Ubuntu runners. UiPath offers two separate command line tools for the different operating systems, UiPath.CLI and UiPath.CLI.Windows installed on Ubuntu and Windows respectively. These have different capabilities in terms of project compatibility, noted in the [Compatiblity Matrix sections of this documentation page](https://docs.uipath.com/test-suite/automation-suite/2022.10/user-guide/uipath-command-line-interface#uipathcliwindows-compatibility-matrix) | ||
|
||
## How to use | ||
Example usage: | ||
|
||
# Set up the UiPath CLI (uipcli) and add it to PATH on your runner | ||
- name: Setup UiPath (uipcli) command line tool | ||
uses: Mikael-RnD/setup-uipath@main | ||
with: | ||
version: # Version number, defaults to 1.0.7985.19721 which was the latest version available at 2021-05-01 | ||
|
||
For further steps in your workflow you can now use uipcli commands. | ||
In further steps of your workflow, you can now use the UiPath CLI (uipcli): | ||
- Packing Studio projects into NuGet packages. | ||
- Deploying NuGet packages to Orchestrator. | ||
- Running jobs in Orchestrator. | ||
- Running Test Sets in Orchestrator. | ||
|
||
[See the UiPath documentation for reference on tasks that can be performed with the command line tool](https://docs.uipath.com/test-suite/automation-suite/2022.10/user-guide/executing-tasks-cli) |