Merge pull request #167 from ulucinar/call-prepare

Directions for calling ./hack/prepare.sh in the provider guide
crossplane · Dec 3, 2021 · 3f0d22f · 3f0d22f
2 parents 0219bf9 + 0a59b3f
commit 3f0d22f
Showing 1 changed file with 3 additions and 9 deletions.
diff --git a/docs/generating-a-provider.md b/docs/generating-a-provider.md
@@ -20,17 +20,11 @@ be quite similar for any other Terraform provider.
         export ProviderNameUpper=GitHub
         ```
 
-    2. Replace all occurrences of `template` with your provider name:
+    2. Run the `./hack/prepare.sh` script from repo root to prepare the repo, e.g., to 
+       replace all occurrences of `template` with your provider name:
 
         ```bash
-        git grep -l 'template' -- './*' ':!build/**' ':!go.sum' | xargs sed -i.bak "s/template/${ProviderNameLower}/g"
-        git grep -l 'Template' -- './*' ':!build/**' ':!go.sum' | xargs sed -i.bak "s/Template/${ProviderNameUpper}/g"
-        # Clean up the .bak files created by sed
-        git clean -fd
-   
-        git mv "internal/clients/template.go" "internal/clients/${ProviderNameLower}.go"
-        git mv "cluster/images/provider-jet-template" "cluster/images/provider-jet-${ProviderNameLower}"
-        git mv "cluster/images/provider-jet-template-controller" "cluster/images/provider-jet-${ProviderNameLower}-controller"
+       ./hack/prepare.sh
         ```
 
 4. Configure your repo for the Terraform provider binary and schema: