Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI job to add settings if tap supports --about #143

Open
MeltyBot opened this issue Oct 18, 2021 · 1 comment
Open

CI job to add settings if tap supports --about #143

MeltyBot opened this issue Oct 18, 2021 · 1 comment

Comments

@MeltyBot
Copy link
Contributor

Migrated from GitLab: https://gitlab.com/meltano/hub/-/issues/146

Originally created by @aaronsteers on 2021-10-18 19:59:23


I think we should write a script to add or update settings documentation from --about --format=json in two forms:

  1. As a one-time job on a loop.
  2. As an on-demand (aka "manual") CI job taking the tap name and variant name as inputs.
  3. 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.
@MeltyBot
Copy link
Contributor Author

@labelsync-manager labelsync-manager bot added the kind/Feature New feature or request label Jun 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants