example-workflow.yaml

# =============================================================================
# wflow Example
# =============================================================================
#
# Этот файл демонстрирует формат workflow для wflow.
# Workflow гарантирует выполнение шагов в указанном порядке.
#
# Запуск:
#   python wflow.py example-workflow.yaml -i task_description="Ваша задача"
# =============================================================================

# Название workflow (отображается при запуске)
name: "Example Workflow"

# Глобальные переменные окружения (доступны во всех шагах через ${{ env.VAR }})
env:
  PROJECT_ROOT: /var/www/project
  AUTHOR: Developer

# Таймаут для всего workflow (в секундах)
timeout: 600

# Режим подтверждения инструментов: DEFAULT, AUTO_EDIT, YOLO, PLAN
# DEFAULT - запрашивает подтверждение для каждого действия
# AUTO_EDIT - автоматически выполняет редактирование
# YOLO - полный авто-режим с возможностью отката
# PLAN - только чтение, без изменений
approval_mode: YOLO

# =============================================================================
# Входные параметры workflow
# =============================================================================
# Указываются при запуске через -i key=value
# Доступны через ${{ inputs.key }}

# =============================================================================
# Шаги workflow
# =============================================================================
# Выполняются строго последовательно.
# Каждый шаг гарантированно выполняется после завершения зависимостей.

steps:
  # ---------------------------------------------------------------------------
  # Шаг 1: Анализ задачи
  # ---------------------------------------------------------------------------
  - name: analyze
    # Описание шага (опционально)
    description: "Анализирует задачу и создаёт план"
    
    # Промпт можно указать прямо здесь
    prompt: |
      Проанализируй следующую задачу и создай план реализации:
      
      Задача: ${{ inputs.task_description }}
      
      Автор: ${{ env.AUTHOR }}
      Проект: ${{ env.PROJECT_ROOT }}
      
      Верни план в формате:
      1. Что нужно сделать
      2. Какие файлы создать/изменить
      3. Потенциальные проблемы
    
    # Формат вывода: text (по умолчанию) или json
    output_format: text

  # ---------------------------------------------------------------------------
  # Шаг 2: Создание структуры
  # ---------------------------------------------------------------------------
  - name: scaffold
    description: "Создаёт файловую структуру"
    
    # Промпт можно загрузить из файла (относительно workflow файла)
    # prompt_file: prompts/scaffold.md
    
    # ИЛИ указать прямо здесь
    prompt: |
      На основе анализа создай необходимую структуру файлов.
      
      План из предыдущего шага:
      ${{ steps.analyze }}
      
      Создай файлы в директории ${{ env.PROJECT_ROOT }}
    
    # Контекст из предыдущих шагов (опционально, для явного указания)
    context:
      - analyze
    
    # Зависимости от предыдущих шагов
    depends_on:
      - analyze
    
    # Разрешённые инструменты для этого шага (опционально)
    # tools:
    #   - write_file
    #   - read_file
    
    # Режим подтверждения для конкретного шага (переопределяет глобальный)
    # approval: ask

  # ---------------------------------------------------------------------------
  # Шаг 3: Реализация
  # ---------------------------------------------------------------------------
  - name: implement
    description: "Реализует основную логику"
    
    prompt: |
      Реализуй код согласно плану:
      
      Предыдущий анализ:
      ${{ steps.analyze }}
      
      Созданная структура:
      ${{ steps.scaffold }}
      
      Напиши качественный код с комментариями.
    
    depends_on:
      - analyze
      - scaffold

  # ---------------------------------------------------------------------------
  # Шаг 4: Тесты (с запросом подтверждения)
  # ---------------------------------------------------------------------------
  - name: tests
    description: "Создаёт тесты"
    
    prompt: |
      Создай тесты для реализованного кода.
      
      Код:
      ${{ steps.implement }}
    
    depends_on:
      - implement
    
    # Запросить подтверждение перед выполнением этого шага
    interactive: true

  # ---------------------------------------------------------------------------
  # Шаг 5: Валидация с обработкой ошибок
  # ---------------------------------------------------------------------------
  - name: validate
    description: "Проверяет код"
    
    prompt: |
      Проверь код:
      1. Синтаксис
      2. Стилистика
      3. Потенциальные баги
      
      Если найдены ошибки - исправь их.
    
    depends_on:
      - implement
      - tests
    
    # Обработка ошибок
    on_failure:
      retry: 2           # Количество повторных попыток
      notify: true       # Вывести уведомление

  # ---------------------------------------------------------------------------
  # Шаг 6: Итоговый отчёт
  # ---------------------------------------------------------------------------
  - name: summary
    description: "Формирует итоговый отчёт"
    
    prompt: |
      Создай итоговый отчёт о выполненной работе.
      
      Включи:
      - Созданные файлы
      - Краткое описание изменений
      - Инструкции по использованию
      - Что нужно доделать вручную
    
    depends_on:
      - validate

# =============================================================================
# Переменные, доступные в промптах:
# =============================================================================
#
# ${{ inputs.KEY }}     - входные параметры (из -i key=value)
# ${{ env.KEY }}        - переменные окружения (из секции env)
# ${{ steps.name }}     - результат выполнения шага
# ${{ steps.name.outputs.field }} - конкретное поле из результата (для JSON)
#
# Также можно использовать ${var} для простых переменных:
# ${PROJECT_ROOT}
# ${component_name}
#
# =============================================================================