Skip to content

Commit

Permalink
docs: update broken links to UiPath docs
Browse files Browse the repository at this point in the history
Replace broken links to UiPath that have been broken after reorganization
of their documentation for the UiPath CLI
  • Loading branch information
mikael-andersson91 committed Dec 11, 2024
1 parent 31d25c3 commit 86359d3
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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/automation-ops/automation-cloud/latest/user-guide/executing-tasks-cli#testing-a-package-or-running-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.

Expand All @@ -12,13 +12,13 @@ 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)
- [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/automation-ops/automation-cloud/latest/user-guide/executing-tasks-cli#api-access-application-scopes). 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/automation-ops/automation-cloud/latest/user-guide/executing-tasks-cli#api-access-application-scopes)

```yml
# Run all publishable unit tests from UiPath projects in this repository, targeting an organization and tenant in UiPath Automation Cloud
Expand Down Expand Up @@ -55,14 +55,12 @@ The example below illustrates how the action can be used for a repository of mul

```

- :warning: **HejDå**

## Inputs

|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/|
|**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|
Expand Down

0 comments on commit 86359d3

Please sign in to comment.