Scaffolder dry-run tool reference

Use this tool to perform a sandboxed dry-run execution of a Scaffolder template.

The following table describes the input fields:

Input parameter Description Example

templateYaml

Full YAML content of the template.

apiVersion: scaffolder…​

values

Key-value map of required input values.

{"name": "my-service"}

files

Additional files including path and content.

[{"path": "README.md", "content": "# Example"}]

The following table describes the output fields:

Output field Description Example

valid

Boolean indicating if the template passed validation.

true

message

Summary of the dry-run result.

"Template validation successful"

errors

List of error messages if valid is false.

["YAML parsing error…​"]

log

List of execution log objects.

log[].message

Log message text from the dry run.

"Running step: fetch:template"

log[].stepId

ID of the step associated with the log.

"fetch"

log[].status

Step status, such as processing.

"processing"

output

Template output produced by the dry run.

{"repoUrl": "…​"}

steps

List of execution step objects.

steps[].id

ID of the step.

"fetch"

steps[].name

Display name of the step.

"Fetch Template"

steps[].action

Action identifier used by the step.

"fetch:template"