Workflow Specification

DevChat operates workflows defined by YAML files, with the syntax inspired by key concepts in CircleCI configuration, such as commands, jobs, and workflows.

Design Principles

The DevChat workflow specification schema adheres to the following principles:

• Compatibility with OpenAI functions: Each command corresponds to an OpenAI function. This unified syntax is crucial, providing users with the flexibility to choose the most suitable method for constructing each individual workflow as desired. Users have the option to:
  • Manually craft specific workflows as YAML files for use with DevChat tools, such as the VS Code extension, or
  • Delegate the dynamic specification of a workflow to AI by supplying a prompt with all associated functions.
• Easy to Use: Commands can be seamlessly integrated into a DevChat prompt as OpenAI functions and run through DevChat. Commands and functions are made interchangeable in DevChat.
• Easy to Read: The YAML format is chosen over JSON due to its superior readability. By defining commands in YAML, users can avoid the more tedious process of defining OpenAI functions in JSON.
• Easy to Organize: Commands can be conveniently reused, amalgamated, and arranged (even in parallel and stages) in YAML files and simple folders, without the need for complex concepts.