Skip to main content

​
Overview

The YAML tab in the Test Editor provides a way to view, edit, and export your test as a structured YAML file. This is useful for:
  • Version control - Store tests in Git alongside your code
  • CI/CD integration - Run tests in GitHub Actions or other CI pipelines
  • Bulk editing - Modify multiple steps at once using text editing
  • Sharing tests - Send test definitions to teammates
  • Documentation - Keep test specifications in your docs

​
Accessing the YAML View

In the Test Editor, click the YAML tab at the top of the editor panel (between Editor and Variables tabs). YAML tab view The YAML view shows your test in a structured format with:
  • Test metadata - Name, platform, build
  • Blocks array - All test steps in order
  • Variables - Preserved using {{variableName}} syntax

​
YAML Structure

test:
  metadata:
    name: Notes App - Create Note Test
    platform: android
  build:
    name: Android Test App
  blocks:
    - type: instructions
      step_description: Type {{username}} in the email field
    - type: validation
      step_description: Check that "Note Editor" screen is visible

​
Key Components

metadata section:
  • name - Test name (required)
  • platform - android or ios (required)
build section:
  • name - Build name to test against (required)
  • pinned_version - Specific version (optional)
blocks array:
  • Each block represents a test step
  • type - Step type (instructions, validation, extraction, manual, if, while)
  • step_description - Natural language instruction

​
YAML Limitations

Code Execution steps are not supported in YAML. Script/code execution steps created in the visual editor cannot be exported to YAML. If your test includes code execution steps, they will be omitted from the YAML export.

​
Downloading YAML Files

Click the Download button in the YAML view to export your test as a .yaml file. YAML download success Filename format: test_{testId}_{test-name}.yaml Example: test_e18a48d4-ae21-46c8-8fba-cbc47102c9c3_notes_app_-_create_note_test.yaml You’ll see a success notification when the download completes.

​
Editing YAML Directly

Click the Edit button to modify the YAML directly in the browser. YAML edit mode Edit mode features:
  • Save - Apply changes and convert back to visual editor
  • Validate - Check YAML syntax without saving
  • Cancel - Discard changes and return to view mode

​
When to Edit YAML

Editing YAML directly is faster when you need to:
  1. Rename steps in bulk - Change similar text across multiple steps
  2. Add multiple steps - Copy and paste similar blocks
  3. Update variables - Replace variable names throughout the test
  4. Restructure tests - Reorder or reorganize large sections
Important: YAML must be valid to save. Use the Validate button to check syntax before saving.

​
Variables in YAML

Variables use Mustache template syntax: {{variableName}} 
blocks:
  - type: instructions
    step_description: Type {{username}} in the email field
  - type: extraction
    step_description: Extract the order ID from the screen
    save_to_variable: orderId
  - type: validation
    step_description: Order {{orderId}} is displayed
Variables are:
  • Case-sensitive
  • Automatically highlighted in the visual editor when recognized
  • Preserved when switching between Editor and YAML views
See Variables for complete variable documentation.

​
Control Flow in YAML

​
If/Else Conditionals

- type: if
  step_description: User is logged in
  blocks:
    - type: instructions
      step_description: Click logout button
  else_blocks:
    - type: instructions
      step_description: Navigate to login page

​
While Loops

- type: while
  step_description: More items are available
  max_iterations: 10
  blocks:
    - type: instructions
      step_description: Click 'Load more' button
Max iterations: While loops require a max_iterations value to prevent infinite loops. Default is 5.

​
Common Issues

​
Empty blocks Array

Issue: YAML shows blocks: [] even though steps exist in the editor Cause: Some steps are missing required fields (empty descriptions) Solution:
  1. Switch back to Editor tab
  2. Fill in or delete incomplete steps
  3. Return to YAML tab to see complete structure

​
Variables Not Recognized

Issue: Variables show as plain text instead of {{variable}} syntax Cause: Variable not defined in Variables tab Solution:
  1. Switch to Variables tab
  2. Create the variable
  3. Return to YAML view - variables will now appear with {{}} syntax

​
YAML Won’t Save

Issue: Save button doesn’t work after editing Cause: Invalid YAML syntax (incorrect indentation, missing colons, etc.) Solution:
  1. Click Validate button to see syntax errors
  2. Fix indentation (use spaces, not tabs)
  3. Ensure all keys have colons: type: instructions
  4. Check that lists use proper dash syntax: - type: instructions

​
YAML Reference Documentation

For comprehensive YAML documentation, see:
Pro Tip: Use YAML export to create test templates. Download a test, modify the YAML, and use it as a starting point for similar tests in your CI/CD pipeline.