CI job to add settings if tap supports `--about`
I think we should write a script to add or update settings documentation from --about --format=json
in two forms:
- As a one-time job on a loop.
- As an on-demand (aka "manual") CI job taking the tap name and variant name as inputs.
- Failures to install or run would be logged for follow-up.
Other notes:
- Ideally, to save execution time, we'd filter this to just those taps which are marked as built with the SDK.
- If running locally, this should probably be run inside a docker container, for easy cleanup afterwards.
- pipx has a pipx run command which bootstraps the install and runs any CLI command. So in theory, this should work:
pipx run {pip_url} --about --format=json > {tap_name}--{variant_name}.about.json
- We'll probably want to smartly merge the output, adding settings if missing but not overriding non-null text descriptions with null ones.
Edited by AJ Steers