|
| 1 | +--- |
| 2 | +id: hyperexecute-workflows |
| 3 | +title: Workflows in HyperExecute |
| 4 | +sidebar_label: Workflows |
| 5 | +description: Schedule and orchestrate HyperExecute jobs without a full CI/CD, chain workflows across projects, and parameterize runs with workflow variables. |
| 6 | +keywords: |
| 7 | + - LambdaTest HyperExecute |
| 8 | + - HyperExecute Workflows |
| 9 | + - schedule tests |
| 10 | + - connected workflows |
| 11 | + - test chains |
| 12 | +url: https://www.lambdatest.com/support/docs/hyperexecute-workflows/ |
| 13 | +site_name: LambdaTest |
| 14 | +slug: hyperexecute-workflows/ |
| 15 | +--- |
| 16 | + |
| 17 | +<script type="application/ld+json" |
| 18 | + dangerouslySetInnerHTML={{ __html: JSON.stringify({ |
| 19 | + "@context": "https://schema.org", |
| 20 | + "@type": "BreadcrumbList", |
| 21 | + "itemListElement": [{ |
| 22 | + "@type": "ListItem", |
| 23 | + "position": 1, |
| 24 | + "name": "Home", |
| 25 | + "item": "https://www.lambdatest.com" |
| 26 | + },{ |
| 27 | + "@type": "ListItem", |
| 28 | + "position": 2, |
| 29 | + "name": "Support", |
| 30 | + "item": "https://www.lambdatest.com/support/docs/" |
| 31 | + },{ |
| 32 | + "@type": "ListItem", |
| 33 | + "position": 3, |
| 34 | + "name": "Workflows in HyperExecute", |
| 35 | + "item": "https://www.lambdatest.com/support/docs/hyperexecute-workflows/" |
| 36 | + }] |
| 37 | + }) |
| 38 | + }} |
| 39 | +></script> |
| 40 | +Workflows give you the speed, reliability, and platform‑native orchestration of HyperExecute on a schedule. Think of Workflows as a lightweight, cloud-native alternative and companion to CI/CD, with all the functionalities of HyperExecute such as reporting, RCA etc. |
| 41 | + |
| 42 | +## Why Workflows |
| 43 | +- **Schedule-first orchestration:** Run regular suites by just connecting your Git repo, without wiring a CI pipeline. |
| 44 | +- **Native to HyperExecute:** Leverage JIT infrastructure, smart test discovery/splitting, and rich artifacts in one place. |
| 45 | +- **Chainable runs:** Trigger downstream workflows on success to form full test chains across projects. |
| 46 | +- **Customizable:** Use Workflow Variables to reuse the same YAML across environments and scenarios. |
| 47 | + |
| 48 | +## How Workflows are Used |
| 49 | +Workflows are schedule and platform driven, not commit-driven yet. Workflows can be thought of as UI alternative for CLI-based executions, if your project is available on Git. They’re great for: |
| 50 | +- Nightly smoke/regression runs across browsers/devices. |
| 51 | +- Scheduled environment checks (staging, pre-prod) before business hours. |
| 52 | +- Chaining suites across multiple repositories or projects. |
| 53 | + |
| 54 | +## Prerequisites |
| 55 | +- A [HyperExecute Project](/support/docs/hyperexecute-projects/) connected to **GitHub** or **Bitbucket**. |
| 56 | +- A HyperExecute YAML present on the specified branch, or provide a Custom YAML during setup. New to YAML? See [Generate YAML](/support/docs/hyperexecute-generate-sample-yaml/) and the [Deep Dive](/support/docs/deep-dive-into-hyperexecute-yaml/). |
| 57 | +- Note: Workflows currently work with the [dynamic mode of test discovery](/support/docs/deep-dive-into-hyperexecute-yaml/#testdiscovery). |
| 58 | + |
| 59 | +## Create a Workflow |
| 60 | +1) In your Project, click **Setup Workflow**. |
| 61 | +2) Enter details: |
| 62 | + - **Workflow name** |
| 63 | + - **Branch name** (source branch containing the YAML) |
| 64 | + - **YAML file path** (path in repo) or add Custom YAML |
| 65 | +3) (Optional) Configure the **schedule** or skip it if you want to run workflow manually. |
| 66 | +4) (Optional) You can **link your workflow** by selecting existing workflows to trigger automatically after this workflow completes successfully. |
| 67 | +5) (Optional) You may also define **Workflow Variables** which can be used in the YAML to customize behavior at runtime for a specific workflow. |
| 68 | +6) Click **Finish** and your workflow is ready. Click on Play button in the workflow list to run the job manually. |
| 69 | + |
| 70 | +All jobs appear under the same Project. View jobs from the Project’s **Jobs** tab or by clicking the workflow name to open **Past Jobs** view. |
| 71 | + |
| 72 | +:::note |
| 73 | +If you don’t see a job after clicking Run or after the scheduled time, open the workflow and check **Past Occurrences**. Runs that failed to create a job (e.g., due to YAML validation, missing file path, or branch mismatch) are listed there with error details. |
| 74 | +::: |
| 75 | + |
| 76 | +<div className="storylane-iframe"> |
| 77 | + <script async src="https://js.storylane.io/js/v2/storylane.js"></script> |
| 78 | + <div className="sl-embed"> |
| 79 | + <iframe loading="lazy" className="sl-demo" src="https://app.storylane.io/demo/mm0v54k4vzmb?embed=inline" name="sl-embed" allow="fullscreen" allowfullscreen></iframe> |
| 80 | + </div> |
| 81 | + </div> |
| 82 | + |
| 83 | +## Connected Workflows (Test Chains) |
| 84 | +Use Workflow Linking to form test chains. For example, run a daily smoke suite first and trigger a broader regression only if smoke passes. You can link across projects you own to coordinate multi-repo testing. |
| 85 | + |
| 86 | +- Learn the pattern with real examples: [Test Chains](/support/docs/hyperexecute-test-chains/) |
| 87 | + |
| 88 | +## Workflow Variables |
| 89 | +Variables let you customize job runs without the need of creating multiple workflows with different YAML configurations for the same project or editing YAML before every run. To set workflow variables for a single workflow, you need to follow the following steps: |
| 90 | +1. Create or edit a workflow. On Step 3, turn on **Workflow Variables** and add these keys (`key_1`, `key_2` and `key_3`) in the **Key** column. |
| 91 | +2. For the values of the corresponding keys, you can: |
| 92 | + - **Add single value**: This value will be considered default when workflow runs through schedule. While manually running you can edit the value at runtime too. |
| 93 | + - **Add multiple values**: Among these, the first value will be considered default while running the workflow through schedule. At runtime, you will be able to select any value from all these. |
| 94 | + - **Do not add any value**: You can keep the value of a key empty too and fill it later at runtime. The value will be passed as `null` if you do not add any value at runtime. |
| 95 | +3. Once you have added all the keys and their values, save the workflow. |
| 96 | +4. You have the flexibility to edit the values for specific keys at the runtime, whenever you are running the workflow manually. |
| 97 | + |
| 98 | +:::note |
| 99 | +Make sure that you have added `vars` parameter in your YAML file in the given format ([know more](/support/docs/deep-dive-into-hyperexecute-yaml/#vars)): |
| 100 | +```json |
| 101 | +vars: |
| 102 | + Variable_1: ${key_1} |
| 103 | + Variable_2: ${key_2} |
| 104 | + Variable_3: ${key_3} |
| 105 | +``` |
| 106 | +::: |
| 107 | + |
| 108 | +<br /> |
| 109 | +<video class="right-side" width="100%" controls id="vid"> |
| 110 | +<source src= {require('../assets/videos/hyperexecute/workflow/workflow_vars.mp4').default} style={{ height: '300px' }} type="video/mp4" /> |
| 111 | +</video> |
| 112 | + |
| 113 | +**Maximum Limits:** |
| 114 | +- Up to **100 variables per workflow**. |
| 115 | +- Up to **25 values per variable**. |
| 116 | +- Value length limit: **500 characters** (excluding commas/spaces). |
| 117 | + |
| 118 | +## FAQ |
| 119 | +- **Which repos are supported for Projects?** Currently **GitHub** and **Bitbucket**. |
| 120 | +- **Is dynamic test discovery required?** Yes, Workflows currently work with the [dynamic mode of test discovery](/support/docs/deep-dive-into-hyperexecute-yaml/#testdiscovery). |
| 121 | +- **Can I trigger other workflows automatically?** Yes, via Workflow Linking to build [Test Chains](/support/docs/hyperexecute-test-chains/). |
| 122 | +- **Among runtime and workflow variables, what takes precedence?** Runtime value > Workflow‑level defaults. |
0 commit comments