Merge pull request #9 from Mikael-RnD/documentation/setup-instructions

docs: setup instructions and input clarifications
Mikael-RnD · Jan 31, 2024 · 75dd18d · 75dd18d
2 parents edc65b5 + 21b6bd5
commit 75dd18d
Showing 1 changed file with 26 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,25 @@
 # UiPath-Test
-GitHub Action for running all publishable test cases in UiPath projects. Detailed test results are provided in json format from this action. They can also be found by navigating to the Testing tab in UiPath Orchestrator. Built as a wrapper around the [UiPath CLI task for running tests from a UiPath project](https://docs.uipath.com/test-suite/automation-suite/2023.10/user-guide/testing-a-packagerunning-a-test-set)
+
+GitHub Action for running all publishable test cases in UiPath projects. Detailed test results are provided in json format from this action. They can also be found by navigating to the Testing tab in UiPath Orchestrator. Built as a wrapper around the [UiPath CLI task for running tests from a UiPath project.](https://docs.uipath.com/test-suite/automation-suite/2023.10/user-guide/testing-a-packagerunning-a-test-set)
+
+The action triggers test cases to be run by robots through UiPath Orchestrator and writes the test result outputs to the [GitHub Actions job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary). See the setup section below on requirements for running test cases.
+
+**Note:** The current version of this action only works on Windows runners
+
+## Setup
+
+This action requires the following things to be set up in UiPath Orchestrator:
+- UiPath CLI installed on GitHub Actions Runner. This can be done by running the [setup-uipath action](https://github.com/Mikael-RnD/setup-uipath) before this action
+- Test robots connected to the target folder/tenant in UiPath Orchestrator
+- [An external application created in Orchestrator](https://docs.uipath.com/automation-cloud/automation-cloud/latest/admin-guide/managing-external-applications) with the access scopes specified in the [UiPath CLI documentation](https://docs.uipath.com/test-suite/automation-cloud/latest/user-guide/executing-tasks-cli). With the credentials passed to this actions input from GitHub Secrets (or other safe credential stores)
 
 ## Example usage
 
 ### Minimum required inputs
 
-Using the minimum required inputs to this action assumes that the action is intended to run tests for all projects in the repository, targeting a tenant/organization within UiPath Automation Cloud, with the credentials for an external application that has been configured with the default application scopes noted [here](https://docs.uipath.com/test-suite/automation-suite/2023.10/user-guide/testing-a-packagerunning-a-test-set).
+Using the minimum required inputs to this action assumes that the action is intended to run tests for all projects in the repository, targeting a tenant/organization within UiPath Automation Cloud, with the credentials for an external application that has been configured with the default application scopes noted [here.](https://docs.uipath.com/test-suite/automation-suite/2023.10/user-guide/testing-a-packagerunning-a-test-set)
 
-      # Run all publishable unit tests from UiPath projects in this repository
+      # Run all publishable unit tests from UiPath projects in this repository, targeting an organization and tenant in UiPath Automation Cloud
       - name: UiPath Test
         uses: RPA-Global/UiPath-Test@v0
         with:
@@ -19,7 +31,7 @@ Using the minimum required inputs to this action assumes that the action is inte
 
 ### All inputs used
 
-The example below illustrates how the action can be used for a repository of multiple UiPath projects, where two specific projects are intended to be tested. This example also illustrates the outputs needed when targeting a non-Automation Cloud Orchestrator setup.
+The example below illustrates how the action can be used for a repository of multiple UiPath projects, where two specific projects are intended to be tested. This example also illustrates the inputs needed when targeting a non-Automation Cloud Orchestrator setup.
 
       # Run all publishable unit tests from the projects Perfomer/project.json and Dispatcher/project.json, targeting an Orchestrator instance in an internal environment 
       - name: UiPath Test
@@ -40,18 +52,18 @@ The example below illustrates how the action can be used for a repository of mul
 
 |Name|Description|Required|Default value|Example value|
 |:--|:--|:--|:--|:--|
-|projectFilePaths|Multiline input containing a list of projects to perform the operations on. If left empty, the action scans for any project.json files in the repository|False||TheProject/project.json|
-|orchestratorUrl|Base URL to Orchestrator instance|False|https://cloud.uipath.com/|https://mycompany.orchestrator.com/|
-|orchestratorTenant|Name of the Orchestrator tenant|True||TestTenant|
-|orchestratorLogicalName|Id of the UiPath organization|True||testorg|
-|orchestratorFolder|The fully qualified name of the Orchestrator folder where processes are deployed to|True||Finance/SE|
-|orchestratorApplicationId|Application ID for the CLI to authenticate with UiPath Orchestrator|True||${{ secrets.ORCHESTRATOR_APP_ID }}|
-|orchestratorApplicationSecret|Application Secret for the CLI to authenticate with UiPath Orchestrator|True||${{ secrets.ORCHESTRATOR_APP_SECRET }}|
-|orchestratorApplicationScope|External application scope|False|"OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Jobs OR.Machines.Read OR.Monitoring OR.Robots.Read OR.Settings.Read OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Users.Read"||
+|**projectFilePaths**|Multiline input containing a list of projects to perform the operations on. If left empty, the action scans for any project.json files in the repository|False||TheProject/project.json|
+|**orchestratorUrl**|Base URL to Orchestrator instance|False|https://cloud.uipath.com/|https://mycompany.orchestrator.com/|
+|**orchestratorTenant**|Name of the Orchestrator tenant|True||TestTenant|
+|**orchestratorLogicalName**|Id of the UiPath organization|True||testorg|
+|**orchestratorFolder**|The fully qualified name of the Orchestrator folder where processes are deployed to|True||Finance/SE|
+|**orchestratorApplicationId**|Application ID for the CLI to authenticate with UiPath Orchestrator|True||${{ secrets.ORCHESTRATOR_APP_ID }}|
+|**orchestratorApplicationSecret**|Application Secret for the CLI to authenticate with UiPath Orchestrator|True||${{ secrets.ORCHESTRATOR_APP_SECRET }}|
+|**orchestratorApplicationScope**|External application scope|False|"OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Jobs OR.Machines.Read OR.Monitoring OR.Robots.Read OR.Settings.Read OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Users.Read"||
 
 ## Outputs
 
 |Name|Description|
 |:--|:--|
-|testExecutionLinks|Comma-separated list of URLs to directly access the test execution(s) triggered by this action|
-|testResults|Markdown formatted table listing the tests that have been run and whether they passed or failed. Each project tested gets its table with a link to the test run in Orchestrator as part of its header|
+|**testExecutionLinks**|Comma-separated list of URLs to directly access the test execution(s) triggered by this action|
+|**testResults**|Markdown formatted table listing the tests that have been run and whether they passed or failed. Each project tested gets its table with a link to the test execution(s) in Orchestrator as part of its header|