Write _index.md to local docs dir on Any TF Provider #2717
Conversation
dynamic/main.go
Outdated
| @@ -94,6 +95,34 @@ func initialSetup() (info.Provider, pfbridge.ProviderMetadata, func() error) { | |||
| info.SchemaPostProcessor(&packageSchema.PackageSpec) | |||
| } | |||
|
|
|||
| if fullDocs { | |||
There was a problem hiding this comment.
Why are we associating "generate a full schema" with "generate a docs page"? Can we allow them to be set independently?
| if fullDocs { | |
| if indexDocsOutDir != "" { |
There was a problem hiding this comment.
This is meant as an internal feature to generate docs for the registry, where my expectation is we'd always want to do it together.
I almost added it as a default part of the fullDocs flag originally, but wanted to be able to specify an outDir (and not write to a physical file if outDir is unspecified).
dynamic/main.go
Outdated
| // Create a custom generator for registry docs (_index.md). | ||
| root := afero.NewMemMapFs() |
There was a problem hiding this comment.
AFAIK, we are just doing this in memory if indexDocsOutDir is ""? We will never save it to disk. Why would we bother doing this at all?
There was a problem hiding this comment.
AIUI, NewMemMapFs is the in-memory option.
dynamic/parameterize/args.go
Outdated
| @@ -102,6 +132,6 @@ func ParseArgs(args []string) (Args, error) { | |||
| remote.Name = args[0] | |||
| return Args{Remote: &remote}, nil | |||
| default: | |||
| return Args{}, fmt.Errorf("expected to be parameterized by 1-3 arguments: <name> [version] [fullDocs=<true|false>]") | |||
| return Args{}, fmt.Errorf("expected to be parameterized by 1-4 arguments: <name> [version] [fullDocs=<true|false>] [indexDocOutDir=<path/to/dir>]") | |||
There was a problem hiding this comment.
We are getting to the point where we should just slap cobra on this. We can do that in a follow-up PR.
pkg/tfgen/installation_docs.go
Outdated
| // **** | ||
| // ## Generate Provider | ||
| // | ||
| // The Foo provider must be installed as a Local Package by following the instructions for Any Terraform Provider: (link) | ||
| // ```bash | ||
| // pulumi package add terraform-provider org/foo | ||
| // ``` | ||
| // **** |
There was a problem hiding this comment.
Go's preferred way to add examples is with indentation.
| // **** | |
| // ## Generate Provider | |
| // | |
| // The Foo provider must be installed as a Local Package by following the instructions for Any Terraform Provider: (link) | |
| // ```bash | |
| // pulumi package add terraform-provider org/foo | |
| // ``` | |
| // **** | |
| // ## Generate Provider | |
| // | |
| // The Foo provider must be installed as a Local Package by following the instructions for Any Terraform Provider: (link) | |
| // ```bash | |
| // pulumi package add terraform-provider org/foo | |
| // ``` |
pkg/tfgen/installation_docs.go
Outdated
| var instructions string | ||
| if strings.Contains(sourceRepo, "pulumi") { | ||
| instructions = fmt.Sprintf( |
There was a problem hiding this comment.
You can't return the if expression (since it isn't an expression), but we should return in it.
| var instructions string | |
| if strings.Contains(sourceRepo, "pulumi") { | |
| instructions = fmt.Sprintf( | |
| if strings.Contains(sourceRepo, "pulumi") { | |
| return fmt.Sprintf( |
guineveresaenger
force-pushed
the
guin/add-index-md-dynamic
branch
3 times, most recently
from
dfce611 to
d78582a
Compare
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
d78582a to
5975878
Compare
guineveresaenger
added
the
blocked
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2717 +/- ##
==========================================
- Coverage 69.64% 69.63% -0.01%
==========================================
Files 301 302 +1
Lines 38726 38757 +31
==========================================
+ Hits 26969 26987 +18
- Misses 10240 10252 +12
- Partials 1517 1518 +1 ☔ View full report in Codecov by Sentry. |
iwahbe
removed
the
blocked
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.