From 010f7a4c582066d4e0e1c0a38cd6633c6cf7bfca Mon Sep 17 00:00:00 2001 From: Mutahhir Hayat Date: Fri, 12 Jan 2024 15:13:23 +0100 Subject: [PATCH] chore: Add placeholder for version, and a blurb on where to find it --- src/readme.ts | 7 ++++++- test/__snapshots__/index.test.ts.snap | 20 ++++++++++++++++---- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/src/readme.ts b/src/readme.ts index 9ec576ec..58a21caf 100644 --- a/src/readme.ts +++ b/src/readme.ts @@ -131,7 +131,12 @@ The go package is generated into the [\`${ \`go get ${packageInfo.publishToGo?.moduleName}/${ packageInfo.publishToGo?.packageName - }\` + }/\` + +Where \`\` is the version of the prebuilt provider you would like to use e.g. \`v11\`. The full module name can be found +within the [go.mod](https://${packageInfo.publishToGo?.moduleName}/blob/main/${ + packageInfo.publishToGo?.packageName + }/go.mod#L1) file. ## Docs diff --git a/test/__snapshots__/index.test.ts.snap b/test/__snapshots__/index.test.ts.snap index 8f6f0fb4..1c193952 100644 --- a/test/__snapshots__/index.test.ts.snap +++ b/test/__snapshots__/index.test.ts.snap @@ -1826,7 +1826,10 @@ The Maven package is available at [https://mvnrepository.com/artifact/com.hashic The go package is generated into the [\`github.com/cdktf/cdktf-provider-random-go\`](https://github.com/cdktf/cdktf-provider-random-go) package. -\`go get github.com/cdktf/cdktf-provider-random-go/random\` +\`go get github.com/cdktf/cdktf-provider-random-go/random/\` + +Where \`\` is the version of the prebuilt provider you would like to use e.g. \`v11\`. The full module name can be found +within the [go.mod](https://github.com/cdktf/cdktf-provider-random-go/blob/main/random/go.mod#L1) file. ## Docs @@ -4250,7 +4253,10 @@ The Maven package is available at [https://mvnrepository.com/artifact/com.hashic The go package is generated into the [\`github.com/cdktf/cdktf-provider-random-go\`](https://github.com/cdktf/cdktf-provider-random-go) package. -\`go get github.com/cdktf/cdktf-provider-random-go/random\` +\`go get github.com/cdktf/cdktf-provider-random-go/random/\` + +Where \`\` is the version of the prebuilt provider you would like to use e.g. \`v11\`. The full module name can be found +within the [go.mod](https://github.com/cdktf/cdktf-provider-random-go/blob/main/random/go.mod#L1) file. ## Docs @@ -7006,7 +7012,10 @@ The Maven package is available at [https://mvnrepository.com/artifact/com.hashic The go package is generated into the [\`github.com/cdktf/cdktf-provider-random-go\`](https://github.com/cdktf/cdktf-provider-random-go) package. -\`go get github.com/cdktf/cdktf-provider-random-go/random\` +\`go get github.com/cdktf/cdktf-provider-random-go/random/\` + +Where \`\` is the version of the prebuilt provider you would like to use e.g. \`v11\`. The full module name can be found +within the [go.mod](https://github.com/cdktf/cdktf-provider-random-go/blob/main/random/go.mod#L1) file. ## Docs @@ -9711,7 +9720,10 @@ The Maven package is available at [https://mvnrepository.com/artifact/com.hashic The go package is generated into the [\`github.com/cdktf/cdktf-provider-random-go\`](https://github.com/cdktf/cdktf-provider-random-go) package. -\`go get github.com/cdktf/cdktf-provider-random-go/random\` +\`go get github.com/cdktf/cdktf-provider-random-go/random/\` + +Where \`\` is the version of the prebuilt provider you would like to use e.g. \`v11\`. The full module name can be found +within the [go.mod](https://github.com/cdktf/cdktf-provider-random-go/blob/main/random/go.mod#L1) file. ## Docs