Skip to content

Docs: Getting Started eval.yaml example is missing required executor property #436

Description

@asilverman

Summary

The Getting Started docs include an eval.yaml example that omits the required executor property. Running the example command fails with:

waza-test azd waza run -v
unknown engine type:

Affected docs

Problem details

The YAML snippet in the docs currently shows fields like name, description, skill, version, and config, but does not include executor.
Without executor, the runtime cannot determine the engine and returns unknown engine type:.

Expected behavior

The Getting Started example should include a valid executor value so the sample runs successfully as written.

Suggested fix

  • Update the Step 6 eval.yaml sample to include the required executor property.
  • Optionally add a short note that executor is required and what values are supported.
  • Verify the exact command in the guide (waza-test azd waza run -v) succeeds after following the documented steps.

Repro steps

  1. Follow https://microsoft.github.io/waza/getting-started/.
  2. Use the evals/code-explainer/eval.yaml snippet shown in Step 6.
  3. Run:
    waza-test azd waza run -v
  4. Observe error:
    unknown engine type:
    

Getting Started screenshot highlighting missing executor in eval.yaml example

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions