#10243 feat: Add plugin docs to installation errors
Pull request opened by
AbrhamYishak
Description
I added the plugin docs to be displayed in the error message when plugin installation fails. I did this by getting the plugin docs from plugin.definition.find_variant() method that returns the variant of a given plugin, then I used the docs of the variant, and if the doc is present, it is added to the error message.
Checklist
• I have read the
contribution guide
Was generative AI tooling used to co-author this PR?
• Yes (please specify the tool below)
Related Issues
• Closes
#2922
Summary by Sourcery
Add relevant plugin documentation links to installation failure messages.
Enhancements:
• Include plugin documentation links in installation failure messages when documentation is available, while preserving existing errors when variant resolution fails.
Tests:
• Add coverage for documentation inclusion and for missing or failed plugin variant resolution during installation errors.
Summary by Sourcery
Improve plugin installation failure messages with links to relevant documentation when available.
New Features:
• Include available plugin documentation links in installation failure messages.
Enhancements:
• Preserve the original installation error when plugin variant documentation cannot be resolved.
Tests:
• Add coverage for documentation links and variant-resolution fallback cases in installation errors.
meltano/meltano