CookbookResult

What cookbook did, or found with check=True.

Usage

Source

CookbookResult(
    path,
    written,
    up_to_date,
    recipes=(),
    findings=(),
)

Attributes

path: Path

The cookbook file, cookbook.json at the project root.

written: bool

True if the file was created or changed.

up_to_date: bool

True if the file on disk matches the project’s recipes (after writing, always True; with check=True, the answer).

recipes: tuple[str, …]

The recipes in the cookbook, in run order.

findings: tuple

With check=True, the check findings that mean the recorded recipes no longer match the recipe folders (so the cookbook cannot be up to date); otherwise empty.