Workspace configuration

A workspace is a directory containing all your Flows and config.yaml. The workspace is usually named .maestro which is the recommendation, but you can name it whatever you like and pass it in when uploading to Maestro Cloud either via CI or using the CLI.

In config.yaml, there are two types of configurations you can make:

  • Maestro configuration (eg when running locally or in your own CI)

  • Maestro Cloud configuration (configuration that applies when running Flows in Maestro Cloud)

Below is an exhaustive list of configuration options that you can set in config.yaml to control execution in Maestro Cloud.

For an exhaustive list of Maestro configuration that impacts local running, please refer to the Maestro docs.

flows, includeTags andexcludeTagsare used both when running locally/in own CI and in Maestro Cloud.

ConfigUseOptionalDocs

flows

Controls what Flows to include when running the workspace.

Yes

Link

includeTags

List of tags to include on each run.

Yes

Link

excludeTags

List of tags to exclude on each run.

Yes

Link

baselineBranch

Information about what branch is your baseline. Useful when integrating with Pull Requests.

Yes

Link

notifications

Who to notify after an Upload finishes processing.

Yes

Link

executionOrder

What Flows to run in sequential order (if desired).

Yes

Link

disableRetries

Option to disable Intelligen Retry functionality.

Yes

Link

# .maestro/config.yaml

# Genric Maestro configuration
flows:
  - "subFolder/*"
includeTags:
  - tagNameToInclude
excludeTags:
  - tagNameToExclude

# Maestro Cloud only configuration
baselineBranch: main
notifications:
  email:
    enabled: true
    recipients:
      - john@something.com
executionOrder:
    continueOnFailure: false # default is true
    flowsOrder:
        - flowA
        - flowB
disableRetries: true
PreviousIntegration with any CI PlatformNextOrganising Flows

Last updated