Write _index.md to local docs dir on Any TF Provider #2717
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iwahbe
reviewed
Dec 11, 2024
iwahbe
reviewed
Dec 12, 2024
guineveresaenger
force-pushed
the
guin/add-index-md-dynamic
branch
3 times, most recently
from
dfce611 to
d78582a
Compare
guineveresaenger
force-pushed
the
guin/add-index-md-dynamic
branch
from
d78582a to
5975878
Compare
guineveresaenger
added
the
blocked
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2717 +/- ##
==========================================
+ Coverage 68.60% 68.67% +0.06%
==========================================
Files 322 322
Lines 41223 41279 +56
==========================================
+ Hits 28282 28349 +67
+ Misses 11348 11333 -15
- Partials 1593 1597 +4 ☔ View full report in Codecov by Sentry. |
iwahbe
removed
the
blocked
guineveresaenger
added a commit
that referenced
this pull request
Dec 16, 2024
Simplify args parsing by using cobra. My hope is that this will make the implementation of #2717 much easier.
This allows modules outside of the bridge to test code that uses `tfbridge.GetLogger`. This will be used by `dynamic`. It may also be used by AWS, which currently has test code which uses the now moved-to-internal logging.InitContext.
This gets us out of the business of writing flag parsing. This does change the format of options. Before, they looked like: ```console $ pulumi package get-schema registry.opentofu.org/owner/provider version fullDocs=true ``` They now look like: ```console $ pulumi package get-schema -- registry.opentofu.org/owner/provider version --fullDocs ```
clean up installation instructions
guineveresaenger
force-pushed
the
guin/add-index-md-dynamic
branch
from
5975878 to
a282973
Compare
iwahbe
approved these changes
Dec 18, 2024
pkg/bridgetest/README.md
Outdated
There was a problem hiding this comment.
Should be removed. In favor of unstable/testutils.
pkg/tfgen/installation_docs.go
Outdated
Comment on lines
103
to
114
| // **** | ||
| // | ||
| // Installation | ||
| // The Foo provider is available as a package in all Pulumi languages: | ||
| // | ||
| // JavaScript/TypeScript: @pulumi/foo | ||
| // Python: pulumi-foo | ||
| // Go: github.com/pulumi/pulumi-foo/sdk/v3/go/foo | ||
| // .NET: Pulumi.foo | ||
| // Java: com.pulumi/foo | ||
| // | ||
| // **** |
There was a problem hiding this comment.
Suggested change
| // **** | |
| // | |
| // Installation | |
| // The Foo provider is available as a package in all Pulumi languages: | |
| // | |
| // JavaScript/TypeScript: @pulumi/foo | |
| // Python: pulumi-foo | |
| // Go: github.com/pulumi/pulumi-foo/sdk/v3/go/foo | |
| // .NET: Pulumi.foo | |
| // Java: com.pulumi/foo | |
| // | |
| // **** | |
| // | |
| // Installation | |
| // The Foo provider is available as a package in all Pulumi languages: | |
| // | |
| // JavaScript/TypeScript: @pulumi/foo | |
| // Python: pulumi-foo | |
| // Go: github.com/pulumi/pulumi-foo/sdk/v3/go/foo | |
| // .NET: Pulumi.foo | |
| // Java: com.pulumi/foo | |
| // |
This was referenced Dec 18, 2024
|
This PR has been shipped in release v3.99.0. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update: Rebased against #2742 which adds Cobra. Blocked until that merges.
This pull request adds a
registryDocsGenerator to the initialSetup call for a dynamic provider.Adjustments to accommodate this change:
terraform, the section needs to be added after the edit rules are applied.info.Repository, which is the source repo of the provider. If it doesn't contain "pulumi" then we're dealing with an Any TF provider._index.mdis written to a user-specified (via flag)--indexDocOutDir. This allows us to write to any location in a file system. Leaving this blank prompts the file to only get written to the virtual filesystem in the bridge._index.mdfile` from hashicorp/random.