feat: setting up

Author: Hayden Young

BUILD.md

@@ -0,0 +1,47 @@
+# Build
+
+## Locally
+
+In order to build the provider locally for testing, you can use the included dev
+container setup in [`.devcontainer/`](./.devcontainer). Running it with VS Code
+is the easiest method, but you can also run it from a terminal:
+
+```shell
+docker build . -f .devcontainer/Dockerfile -t dcps
+...
+docker run --rm -it -v $(pwd):/build -w /build dcps
+build@368612b0ea8c:/build$
+```
+
+Once you're in the container, you can use the included [`Makefile`](./Makefile)
+to build the SDKs included (Node.js, Python, .NET Core and Golang) by running
+the `build` target.
+
+```shell
+build@368612b0ea8c:/build$ make build
+...
+```
+
+Once this has completed, you will see a `dotnet`, `go`, `nodejs` and `python`
+folder appear in the [`sdk`](./sdk) directory. These are the compiled/generated
+SDKs for use with Pulumi.
+
+## Release
+
+To make a release, there is a two-step process to go through. The first step is
+making tags for the releases.
+
+```shell
+$ git tag v1.0.2 # used for the nodejs, python and dotnet releases
+$ git tag sdk/v1.0.2 # used for the golang release
+```
+
+Then, you just need to push your tags.
+
+```shell
+$ git push --tags
+```
+
+Once done, [GitHub Actions](./.github/workflows/release.yaml) will take over and
+(assuming you have set up the required environment variables on GitHub's end)
+build & release the SDKs to NPM, PyPI, and NuGet.

Makefile

@@ -1,8 +1,8 @@
-PROJECT_NAME := xyz Package
+PROJECT_NAME := netbox Package
 
 SHELL            := /bin/bash
-PACK             := xyz
-ORG              := pulumi
+PACK             := netbox
+ORG              := hbjydev
 PROJECT          := github.com/${ORG}/pulumi-${PACK}
 NODE_MODULE_NAME := @pulumi/${PACK}
 TF_NAME          := ${PACK}
@@ -29,13 +29,13 @@ prepare::
 	mv "provider/cmd/pulumi-resource-x${EMPTY_TO_AVOID_SED}yz" provider/cmd/pulumi-resource-${NAME}
 
 	if [[ "${OS}" != "Darwin" ]]; then \
-		sed -i 's,github.com/pulumi/pulumi-xyz,${REPOSITORY},g' provider/go.mod; \
+		sed -i 's,github.com/pulumi/pulumi-netbox,${REPOSITORY},g' provider/go.mod; \
 		find ./ ! -path './.git/*' -type f -exec sed -i 's/[x]yz/${NAME}/g' {} \; &> /dev/null; \
 	fi
 
 	# In MacOS the -i parameter needs an empty string to execute in place.
 	if [[ "${OS}" == "Darwin" ]]; then \
-		sed -i '' 's,github.com/pulumi/pulumi-xyz,${REPOSITORY},g' provider/go.mod; \
+		sed -i '' 's,github.com/pulumi/pulumi-netbox,${REPOSITORY},g' provider/go.mod; \
 		find ./ ! -path './.git/*' -type f -exec sed -i '' 's/[x]yz/${NAME}/g' {} \; &> /dev/null; \
 	fi
 

README-PROVIDER.md

@@ -1,6 +1,6 @@
-# Foo Resource Provider
+# Netbox Resource Provider
 
-The Foo Resource Provider lets you manage [Foo](http://example.com) resources.
+The Netbox Resource Provider lets you manage [Netbox](https://netbox.dev) resources.
 
 ## Installing
 
@@ -11,46 +11,46 @@ This package is available for several languages/platforms:
 To use from JavaScript or TypeScript in Node.js, install using either `npm`:
 
 ```bash
-npm install @pulumi/foo
+npm install @hbjydev/pulumi-netbox
 ```
 
 or `yarn`:
 
 ```bash
-yarn add @pulumi/foo
+yarn add @hbjydev/pulumi-netbox
 ```
 
 ### Python
 
 To use from Python, install using `pip`:
 
 ```bash
-pip install pulumi_foo
+pip install pulumi_netbox
 ```
 
 ### Go
 
 To use from Go, use `go get` to grab the latest version of the library:
 
 ```bash
-go get github.com/pulumi/pulumi-foo/sdk/go/...
+go get github.com/hbjydev/pulumi-netbox/sdk/go/...
 ```
 
 ### .NET
 
 To use from .NET, install using `dotnet add package`:
 
 ```bash
-dotnet add package Pulumi.Foo
+dotnet add package HBJYDev.Netbox
 ```
 
 ## Configuration
 
 The following configuration points are available for the `foo` provider:
 
-- `foo:apiKey` (environment: `FOO_API_KEY`) - the API key for `foo`
-- `foo:region` (environment: `FOO_REGION`) - the region in which to deploy resources
+- `netbox:apiToken` (environment: `FOO_API_KEY`) - the API key for `foo`
+- `netbox:hostname` (environment: `FOO_REGION`) - the region in which to deploy resources
 
 ## Reference
 
-For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/foo/api-docs/).
+For detailed reference documentation, please visit [the Pulumi registry](https://www.pulumi.com/registry/packages/netbox/api-docs/).

README.md

@@ -54,7 +54,7 @@ From the templated repository:
    This will do the following:
    - rename folders in `provider/cmd` to `pulumi-resource-foo` and `pulumi-tfgen-foo`
    - 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 `netbox` with the `NAME` of your provider.
 
    Note for third-party providers:
    - Make sure to set the correct GitHub organization/username in all files referencing your provider as a dependency:
@@ -359,7 +359,7 @@ before:
   hooks:
   - make tfgen
 builds:
-- binary: pulumi-resource-xyz
+- binary: pulumi-resource-netbox
   dir: provider
   goarch:
   - amd64
@@ -370,8 +370,8 @@ builds:
   - linux
   ignore: []
   ldflags:
-  - -X github.com/pulumi/pulumi-xyz/provider/pkg/version.Version={{.Tag}}
-  main: ./cmd/pulumi-resource-xyz/
+  - -X github.com/pulumi/pulumi-netbox/provider/pkg/version.Version={{.Tag}}
+  main: ./cmd/pulumi-resource-netbox/
   sort: asc
   use: git
 release:
@@ -396,18 +396,18 @@ dist
 ├── artifacts.json
 ├── config.yaml
 ├── metadata.json
-├── pulumi-xyz_darwin_amd64_v1
-│   └── pulumi-resource-xyz
-├── pulumi-xyz_darwin_arm64
-│   └── pulumi-resource-xyz
-├── pulumi-xyz_linux_amd64_v1
-│   └── pulumi-resource-xyz
-├── pulumi-xyz_linux_arm64
-│   └── pulumi-resource-xyz
-├── pulumi-xyz_windows_amd64_v1
-│   └── pulumi-resource-xyz.exe
-└── pulumi-xyz_windows_arm64
-    └── pulumi-resource-xyz.exe
+├── pulumi-netbox_darwin_amd64_v1
+│   └── pulumi-resource-netbox
+├── pulumi-netbox_darwin_arm64
+│   └── pulumi-resource-netbox
+├── pulumi-netbox_linux_amd64_v1
+│   └── pulumi-resource-netbox
+├── pulumi-netbox_linux_arm64
+│   └── pulumi-resource-netbox
+├── pulumi-netbox_windows_amd64_v1
+│   └── pulumi-resource-netbox.exe
+└── pulumi-netbox_windows_arm64
+    └── pulumi-resource-netbox.exe
 ```
 
 Any of the provider binaries can be used to target the correct machine architecture

deployment-templates/.goreleaser.yml

@@ -5,7 +5,7 @@ before:
   hooks:
     - make tfgen
 builds:
-  - binary: pulumi-resource-xyz
+  - binary: pulumi-resource-netbox
     dir: provider
     env:
       - CGO_ENABLED=0
@@ -18,8 +18,8 @@ builds:
       - linux
     ldflags:
       # The line below MUST align with the module in current provider/go.mod
-      - -X github.com/your-org-name/pulumi-xyz/provider/pkg/version.Version={{.Tag }}
-    main: ./cmd/pulumi-resource-xyz/
+      - -X github.com/your-org-name/pulumi-netbox/provider/pkg/version.Version={{.Tag }}
+    main: ./cmd/pulumi-resource-netbox/
 changelog:
   skip: true
 release:

examples/go.mod

@@ -1,3 +1,3 @@
-module github.com/pulumi/pulumi-xyz/examples
+module github.com/hbjydev/pulumi-netbox/examples
 
 go 1.16

provider/cmd/pulumi-resource-xyz/.gitignore provider/cmd/pulumi-resource-netbox/.gitignore

@@ -20,14 +20,14 @@ import (
 	_ "embed"
 
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge"
-	xyz "github.com/pulumi/pulumi-xyz/provider"
-	"github.com/pulumi/pulumi-xyz/provider/pkg/version"
+	netbox "github.com/hbjydev/pulumi-netbox/provider"
+	"github.com/hbjydev/pulumi-netbox/provider/pkg/version"
 )
 
 //go:embed schema-embed.json
 var pulumiSchema []byte
 
 func main() {
 	// Modify the path to point to the new provider
-	tfbridge.Main("xyz", version.Version, xyz.Provider(), pulumiSchema)
+	tfbridge.Main("netbox", version.Version, netbox.Provider(), pulumiSchema)
 }

provider/cmd/pulumi-resource-xyz/generate.go provider/cmd/pulumi-resource-netbox/generate.go

@@ -16,11 +16,11 @@ package main
 
 import (
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfgen"
-	xyz "github.com/pulumi/pulumi-xyz/provider"
-	"github.com/pulumi/pulumi-xyz/provider/pkg/version"
+	netbox "github.com/hbjydev/pulumi-netbox/provider"
+	"github.com/hbjydev/pulumi-netbox/provider/pkg/version"
 )
 
 func main() {
 	// Modify the path to point to the new provider
-	tfgen.Main("xyz", version.Version, xyz.Provider())
+	tfgen.Main("netbox", version.Version, netbox.Provider())
 }