generate-playbook-index

Documentation

Overview

generate-playbook-index walks a playbook directory tree and writes a machine-readable index that lists every playbook's id, name, description, version and tags. Other tools (e.g. the assertoor web UI's remote library tab) read the index instead of fetching each playbook individually.

Folders may include an optional `_header.yaml` to give the folder a human-readable name and description; those are emitted in the `folders:` section of the generated index.

Usage:

go run scripts/generate-playbook-index/generate-playbook-index.go <playbooks-dir>

The index is written to <playbooks-dir>/_index.yaml.