Let the user know if a TF provider repo is not found during docs generation #528
Labels
area/docsgen
Issues with docs capture or example rendering, historically part of pkg/tfgen
kind/enhancement
Improvements or new features
resolution/fixed
This issue was fixed
If e.g.
GitHubOrg
is missing, all entity docs will not be found, but there's no feedback to the user that the entire repo was not found. (Seetfgen.getRepoPath
for details.)By default, we should return an error indicating that the repo path cannot be found and therefore no docs will be found for anything. The user should ensure that the following values are correct in
tfbridge.ProviderInfo
:Name
GitHubOrg
TFProviderModuleVersion
(if the TF provider has a Go module version > 1)And less commonly:
GitHubHost
if not github.aaakk.us.kgAlso, show the exact path we searched on disk.
This behavior can continue to be controlled
PULUMI_MISSING_DOCS_ERROR
because if this flag is true, we not only want a detailed message that a particular entity's docs can be found, but also that the entire repo cannot be found.The text was updated successfully, but these errors were encountered: