v1.55.0

what

• Add atmos describe workflows CLI command (https://atmos.tools/cli/commands/describe/workflows)

• Update the --dry-run flag for atmos workflow CLI command

• Add interactive UI for atmos workflow command (https://atmos.tools/cli/commands/workflow)

why

• Use atmos describe workflows command to show all configured Atmos workflows

  Examples

  atmos describe workflows
  atmos describe workflows --output map
  atmos describe workflows -o list
  atmos describe workflows -o all
  atmos describe workflows -o list --format json
  atmos describe workflows -o all -f yaml
  atmos describe workflows -f json

  Flags

  Flag	Description	Alias	Required
  --format	Specify the output format: yaml or json (yaml is default)	-f	no
  --output	Specify the output type: list, map or all (list is default)	-o	no

  
  

  When the --output list flag is passed (default), the output of the command is a list of objects. Each object has the following schema:

  • file - the workflow manifest file name
  • workflow - the name of the workflow defined in the workflow manifest file

  For example:

  atmos describe workflows
  atmos describe workflows -o list

  - file: compliance.yaml
    workflow: deploy/aws-config/global-collector
  - file: compliance.yaml
    workflow: deploy/aws-config/superadmin
  - file: compliance.yaml
    workflow: destroy/aws-config/global-collector
  - file: compliance.yaml
    workflow: destroy/aws-config/superadmin
  - file: datadog.yaml
    workflow: deploy/datadog-integration
  - file: helpers.yaml
    workflow: save/docker-config-json
  - file: networking.yaml
    workflow: apply-all-components
  - file: networking.yaml
    workflow: plan-all-vpc-components
  - file: networking.yaml
    workflow: plan-all-vpc-flow-logs-bucket-components
  - file: vpc.yaml
    workflow: vpc-tgw-eks

  
  

  When the --output map flag is passed, the output of the command is a map of workflow manifests to the lists of workflows defined in each manifest.
  For example:

  atmos describe workflows -o map

  compliance.yaml:
    - deploy/aws-config/global-collector
    - deploy/aws-config/superadmin
    - destroy/aws-config/global-collector
    - destroy/aws-config/superadmin
  datadog.yaml:
    - deploy/datadog-integration
  helpers.yaml:
    - save/docker-config-json
  networking.yaml:
    - apply-all-components
    - plan-all-vpc-components
    - plan-all-vpc-flow-logs-bucket-components
  vpc.yaml:
    - vpc-tgw-eks

  
  

  When the --output all flag is passed, the output of the command is a map of workflow manifests to the maps of all workflow definitions. For example:

  atmos describe workflows -o all

  networking.yaml:
    apply-all-components:
      description: |
        Run 'terraform apply' on all components in all stacks
      steps:
        - command: terraform apply vpc-flow-logs-bucket -s plat-ue2-dev -auto-approve
        - command: terraform apply vpc -s plat-ue2-dev -auto-approve
        - command: terraform apply vpc-flow-logs-bucket -s plat-uw2-dev -auto-approve
   plan-all-vpc-components:
      description: |
        Run 'terraform plan' on all 'vpc' components in all stacks
      steps:
        - command: terraform plan vpc -s plat-ue2-dev
        - command: terraform plan vpc -s plat-uw2-dev
        - command: terraform plan vpc -s plat-ue2-staging
    plan-all-vpc-flow-logs-bucket-components:
      description: |
        Run 'terraform plan' on all 'vpc-flow-logs-bucket' components in all stacks
      steps:
        - command: terraform plan vpc-flow-logs-bucket -s plat-ue2-dev
        - command: terraform plan vpc-flow-logs-bucket -s plat-uw2-dev
        - command: terraform plan vpc-flow-logs-bucket -s plat-ue2-staging

  
  

• Update the --dry-run flag for atmos workflow CLI command. When the --dry-run flag is passed, always show the workflow steps being executed (but without executing them) regardless of the Atmos logs level

  
  

• Add interactive UI for atmos workflow command. Just run atmos workflow (without any arguments and flags) to start an interactive UI (TUI) to view, search and execute the configured Atmos workflows:

atmos workflow

• Use the right/left arrow keys to navigate between the "Workflow Manifests", "Workflows" and the selected workflow views

• Use the up/down arrow keys (or the mouse wheel) to select a workflow manifest and a workflow to execute

• Use the / key to filter/search for the workflow manifests and workflows in the corresponding views

• Press Enter to execute the selected workflow from the selected workflow manifest