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

Let the user know if a TF provider repo is not found during docs generation #528

Closed
jkodroff opened this issue May 26, 2022 · 1 comment
Closed
Assignees
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

Comments

@jkodroff
Copy link
Member

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. (See tfgen.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.com

Also, 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.

@jkodroff jkodroff added the kind/enhancement Improvements or new features label May 26, 2022
@jkodroff jkodroff changed the title Improve behavior if a TF provider repo is not found Let the user know if a TF provider repo is not found during docs generation May 26, 2022
@jkodroff jkodroff self-assigned this May 31, 2022
@jkodroff jkodroff added the area/tfgen Issues in pkg/tgen, excluding docs generation - use area/docsgen for those label Jun 22, 2022
@jkodroff jkodroff removed their assignment Aug 15, 2022
@t0yv0 t0yv0 mentioned this issue Mar 13, 2023
8 tasks
@t0yv0 t0yv0 added area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen and removed area/tfgen Issues in pkg/tgen, excluding docs generation - use area/docsgen for those labels Apr 5, 2023
@iwahbe iwahbe self-assigned this Dec 3, 2024
@iwahbe iwahbe added the resolution/fixed This issue was fixed label Dec 3, 2024
@iwahbe
Copy link
Member

iwahbe commented Dec 3, 2024

We do this now. The warning for a missing provider repo prints out what the user needs to set so the repo can be found.

@iwahbe iwahbe closed this as completed Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

3 participants