feat: Adds a prepare target to makefile (#95)

* feat: Adds a prepare target to makefile

Adds a prepare target to makefile to globally replace instances of `xyz` and `abc`.
This should make it easier for users to get started.
This is similar to what is done in pulumi-tf-provider-boilerplate.

It skips the sdk and examples directory to illustrate what needs to be changed initially.

* fix: Make prepare now skips lines containing SED_SKIP

Add the ability for make prepare to skip certain lines where we don't want to replace values.
We use 'abc' and 'xyz' in our provider/provider.go file in our random number function. We do not actually want to do that.

* remove ./examples from the exceptions because the yaml file actually needs the replace

Author: zbuchheit

Makefile

@@ -3,8 +3,8 @@ PROJECT_NAME := Pulumi Xyz Resource Provider
 PACK             := xyz
 PACKDIR          := sdk
 PROJECT          := github.com/pulumi/pulumi-xyz
-NODE_MODULE_NAME := @pulumi/xyz
-NUGET_PKG_NAME   := Pulumi.Xyz
+NODE_MODULE_NAME := @abc/xyz
+NUGET_PKG_NAME   := Abc.Xyz
 
 PROVIDER        := pulumi-resource-${PACK}
 VERSION         ?= $(shell pulumictl get version)
@@ -17,6 +17,29 @@ WORKING_DIR     := $(shell pwd)
 EXAMPLES_DIR    := ${WORKING_DIR}/examples/yaml
 TESTPARALLELISM := 4
 
+OS := $(shell uname)
+
+prepare::
+	@if test -z "${NAME}"; then echo "NAME not set"; exit 1; fi
+	@if test -z "${REPOSITORY}"; then echo "REPOSITORY not set"; exit 1; fi
+	@if test -z "${ORG}"; then echo "ORG not set"; exit 1; fi
+	@if test ! -d "provider/cmd/pulumi-resource-xyz"; then "Project already prepared"; exit 1; fi # SED_SKIP
+
+	mv "provider/cmd/pulumi-resource-xyz" provider/cmd/pulumi-resource-${NAME} # SED_SKIP
+
+	if [[ "${OS}" != "Darwin" ]]; then \
+		find . \( -path './.git' -o -path './sdk' \) -prune -o -not -name 'go.sum' -type f -exec sed -i '/SED_SKIP/!s,github.com/pulumi/pulumi-[x]yz,${REPOSITORY},g' {} \; &> /dev/null; \
+		find . \( -path './.git' -o -path './sdk' \) -prune -o -not -name 'go.sum' -type f -exec sed -i '/SED_SKIP/!s/[xX]yz/${NAME}/g' {} \; &> /dev/null; \
+		find . \( -path './.git' -o -path './sdk' \) -prune -o -not -name 'go.sum' -type f -exec sed -i '/SED_SKIP/!s/[aA]bc/${ORG}/g' {} \; &> /dev/null; \
+	fi
+
+	# In MacOS the -i parameter needs an empty string to execute in place.
+	if [[ "${OS}" == "Darwin" ]]; then \
+		find . \( -path './.git' -o -path './sdk' \) -prune -o -not -name 'go.sum' -type f -exec sed -i '' '/SED_SKIP/!s,github.com/pulumi/pulumi-[x]yz,${REPOSITORY},g' {} \; &> /dev/null; \
+		find . \( -path './.git' -o -path './sdk' \) -prune -o -not -name 'go.sum' -type f -exec sed -i '' '/SED_SKIP/!s/[xX]yz/${NAME}/g' {} \; &> /dev/null; \
+		find . \( -path './.git' -o -path './sdk' \) -prune -o -not -name 'go.sum' -type f -exec sed -i '' '/SED_SKIP/!s/[aA]bc/${ORG}/g' {} \; &> /dev/null; \
+	fi
+
 ensure::
 	cd provider && go mod tidy
 	cd sdk && go mod tidy

README.md

@@ -46,7 +46,18 @@ Pulumi offers this repository as a [GitHub template repository](https://docs.git
 
 From the templated repository:
 
-1. Search-replace `xyz` with the name of your desired provider.
+1. Run the following command to update files to use the name of your provider (third-party: use your GitHub organization/username):
+
+    ```bash
+    make prepare NAME=foo REPOSITORY=github.com/pulumi/pulumi-foo ORG=myorg
+    ```
+
+   This will do the following:
+   - rename folders in `provider/cmd` to `pulumi-resource-{NAME}`
+   - replace dependencies in `provider/go.mod` to reflect your repository name
+   - find and replace all instances of the boilerplate `xyz` with the `NAME` of your provider.
+   - find and replace all instances of the boilerplate `abc` with the `ORG` of your provider.
+   - replace all instances of the `github.com/pulumi/pulumi-xyz` repository with the `REPOSITORY` location
 
 #### Build the provider and install the plugin
 

provider/provider.go

@@ -81,7 +81,7 @@ func (Random) Create(ctx p.Context, name string, input RandomArgs, preview bool)
 
 func makeRandom(length int) string {
 	seededRand := rand.New(rand.NewSource(time.Now().UnixNano()))
-	charset := []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
+	charset := []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789") // SED_SKIP
 
 	result := make([]rune, length)
 	for i := range result {