Project configuration

Configure your workspace with config.yaml for test suite settings.

The config.yaml file is the optional central place for settings that apply to a whole workspace. If you only run a single flow file, you do not need one. It becomes useful when your project grows and you need to control which flows run and in what order.

What Astra Scout reads

When you run a whole workspace, Astra Scout reads config.yaml (or config.yml) from the workspace root and honors these keys: flows, includeTags, excludeTags, and executionOrder.flowsOrder. Other Maestro keys are accepted in the file but have no effect. See Keys that have no effect.

When do I need a config file?

Create a config.yaml if:

• You have a deep directory structure and need to define test discovery.
• You want some flows to always run, or never run, based on their tags.
• You want a few flows to run first, in a fixed order.

Setting up your configuration

The file lives at the root of the workspace folder you open in Astra Scout. Name it exactly config.yaml. If no config file is present, Astra Scout runs with default settings: only the flow files at the top level of the folder are discovered.

Configure where flows are stored

Use the flows key to define where the test flows are stored. Typically this is a single line, but you can give a list. Simple glob syntax is supported: * means the contents of a folder, and ** includes all subfolders too. Prefix a pattern with ! to exclude files.

# config.yaml
flows:
  - e2e/*
  - smoke/**

See Test discovery and tags for the details.

Filter by tags and set the order

# config.yaml
includeTags:
  - production_ready
excludeTags:
  - flaky
executionOrder:
  flowsOrder:
    - signup_flow
    - verify_email_flow

See Test discovery and tags and Sequential execution.

Keys that have no effect

WARNING

Maestro's config.yaml supports more keys than Astra Scout reads. These are accepted but ignored when you run from Astra Scout:

• platform (for example platform.ios.snapshotKeyHonorModalViews)
• testOutputDir
• executionOrder.continueOnFailure
• Cloud-only keys such as disableAnimations

Astra Scout also does not have a --config option to switch between several config files for a run.

Next steps

To plan your test architecture, read Design your test architecture. To organize your tests with the flows key, read Test discovery and tags.