Developer
User Docs ↗

NAME

generate-third-party-readme - generate devel/third-party/README from metadata

SYNOPSIS

    devel/tools/generate-third-party-readme [--write | --check]

DESCRIPTION

Reads each devel/third-party/*/metadata.yml file and produces the aggregate devel/third-party/README from it. README is generated; do not edit it by hand. See devel/third-party/SCHEMA.md for the metadata schema.

OPTIONS

--write

Write the generated content to devel/third-party/README, replacing it.

--check

Compare the generated content against the committed README. Exit 0 if they match, 1 otherwise. Intended for CI use, to ensure the committed README stays in sync with the per-library metadata.

--help

Print this help.

← Back to index