From ccc81a25e654de835c4490aed7f05b02a7a73432 Mon Sep 17 00:00:00 2001 From: Ryan Parman Date: Sun, 15 Oct 2023 01:32:49 -0600 Subject: [PATCH] docs: Updated the generator docs. --- generator/README.md | 8 ++++---- generator/main.go | 5 ++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/generator/README.md b/generator/README.md index 143525f..2d8b35c 100644 --- a/generator/README.md +++ b/generator/README.md @@ -17,6 +17,10 @@ After that, search the project for `@TODO` and make the appropriate changes. Exc ## Checklist * [ ] Generate the stub files. +* [ ] In the new `examples/data-sources/*/data-source.tf` file, ensure the example is implemented correctly. +* [ ] In the new `examples/data-sources/*/terraform-plan.example` file, copy content or delete. +* [ ] In the new `templates/data-sources/*.tmpl` file, update the template that will be used by the `tfplugindocs` package. +* [ ] Generate the Terraform provider documentation. * [ ] In the new `*_data_source.go` file, update the `*SourceModel` struct. * [ ] In the new `*_data_source.go` file, update the Schema Attributes to match the `*SourceModel` struct. * [ ] In the new `*_data_source.go` file, implement the remainder of the `Read` function. @@ -24,10 +28,6 @@ After that, search the project for `@TODO` and make the appropriate changes. Exc * [ ] In the new `*_data_source_fixture.tftpl` file, ensure the fixture is implemented correctly. * [ ] In the new `*_data_source_test.go` file, ensure the test references the fixture correctly. * [ ] Run the integration tests. -* [ ] In the new `examples/data-sources/*/data-source.tf` file, ensure the example is implemented correctly. -* [ ] In the new `examples/data-sources/*/terraform-plan.example` file, copy content or delete. -* [ ] In the new `templates/data-sources/*.tmpl` file, update the template that will be used by the `tfplugindocs` package. -* [ ] Generate the Terraform provider documentation. * [ ] Run `tfschema data show -format=json DATASOURCE | jq -Mrc '.attributes[]'`. * [ ] In the new `bats/*.bats.sh` file, update its contents to match the `tfschema` output. * [ ] Run the bats tests. diff --git a/generator/main.go b/generator/main.go index 8d48896..ad9a282 100644 --- a/generator/main.go +++ b/generator/main.go @@ -33,6 +33,8 @@ func main() { panic(err) } + fmt.Println("") + fmt.Println("Add " + varMap["PascalStrip"] + "DataSource" + " to " + getAbs("../corefuncprovider/provider.go")) fmt.Println("") // ../bats @@ -97,9 +99,6 @@ func main() { getAbs("./examples/versions.tftpl"), getAbs(edsPath+"/versions.tftpl"), ) - - fmt.Println("") - fmt.Println("Add " + varMap["PascalStrip"] + "DataSource" + " to " + getAbs("../corefuncprovider/provider.go")) } func getAbs(path string) string {