Stage Meta configuration

Stage Meta-Configuration in Togomak consists of specific properties that allow you to control and customize the behavior of individual stages within your automation workflows. These properties provide essential metadata and decision-making capabilities for stages, ensuring proper execution and coordination.

togomak {
  version = 2
}
 
stage "my_stage" {
  name = "Data Processing"
  depends_on = [stage.another_stage]
  script = "echo this runs second"
}
 
stage "another_stage" {
  if = 3 != 4
  script = "echo this runs first"
}

name

Specifies a friendly and human-readable name for the stage.

This property is optional but recommended. Providing a meaningful name helps you identify the purpose or role of each stage within your Togomak configuration. It enhances clarity and makes the configuration more readable.

depends_on

Defines a list of dependencies that a stage needs to wait for before executing.

This property is optional but crucial for managing the execution order of stages. By specifying dependencies, you ensure that certain stages complete before others start. Dependencies are referenced using Togomak references, such as stage.<name_of_stage>. This property is particularly useful when one stage relies on the output or results of another.

if

Accepts a boolean value that determines whether the stage should be executed or skipped based on the condition's result.

This property is optional and provides a way to conditionally run or skip stages. If stages are whitelisted as command-line arguments in the Togomak CLI, the if property takes precedence over command-line arguments. It allows you to make execution decisions based on specific conditions, making your automation more dynamic. However, if the stage explicitly whitelisted using the + operator on Togomak Command Line Arguments, the result of the if property is ignored.

For example, take a look at the following script:

togomak {
  version = 2
}
 
stage "build" {
  script = "echo running build"
}
 
stage "test" {
  if = false
  script = "echo running test"
}

The above script may run only the stage.build stage when run using the following command

togomak

However, when its explicitly whitelisted, you can force the stage.test stage to run as well.

togomak +test

And you can run only the stage.test stage with the following command

togomak root +test

To learn more on how filtering works, check out the Command Line docs.