Merge pull request #44 from cortexapps/fix-rules-order

Fix: Rules should be a SetNestedAttribute resource everywhere

Author: maddymanu

.gitignore

@@ -27,6 +27,7 @@ website/node_modules
 
 website/vendor
 vendor/
+build/
 
 # Test exclusions
 !command/test-fixtures/**/*.tfstate

CHANGELOG.md

@@ -2,6 +2,9 @@ Changelog for the Cortex terraform provider.
 
 ## Unreleased
 
+## 0.4.2
+* Fixes `cortex_scorecard` resource so that `rules` are a set. Order doesn't matter.
+
 ## 0.4.1
 * Fixes `cortex_scorecard` resource so that `description` and `filter` fields can be computed from provider response
 

Makefile

@@ -2,7 +2,7 @@ HOSTNAME=github.com
 NAMESPACE=cortexapps
 NAME=cortex
 BINARY=terraform-provider-${NAME}
-VERSION=0.4.2-dev
+VERSION=0.4.3-dev
 
 GOOS?=$(shell go env | grep GOOS | cut -d '=' -f2 | tr -d "'")
 GOARCH?=$(shell go env | grep GOARCH | cut -d '=' -f2 | tr -d "'")

README.md

@@ -78,6 +78,37 @@ see [Requirements](#requirements) above).
 To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin`
 directory.
 
+To be able to use the **locally installed provider**, 
+
+1. Run `go build -o build/terraform-provider-cortex .`
+This will build the binary and put it in the `build/` directory.
+
+2. Create a `~/.terraformrc` file that lets you override the default provider location:
+```terraform
+provider_installation {
+  dev_overrides {
+    "cortexlocal/cortex" = "<path/to/terraform-provider-cortex/build"
+  }
+  direct {}
+}
+```
+
+3. Use the `provider` as:
+
+```terraform
+terraform {
+  required_providers {
+    cortex = {
+      source  = "cortexlocal/cortex"
+    }
+  }
+}
+```
+
+### Documentation
+
+```shell
+
 To generate or update documentation, run `go generate`.
 
 In order to run the full suite of Acceptance tests, run `make testacc`.

docs/data-sources/scorecard.md

@@ -28,7 +28,7 @@ Scorecard data source
 - `id` (String) The ID of this resource.
 - `ladder` (Attributes) (see [below for nested schema](#nestedatt--ladder))
 - `name` (String)
-- `rules` (Attributes List) Rules of the scorecard. (see [below for nested schema](#nestedatt--rules))
+- `rules` (Attributes Set) Rules of the scorecard. (see [below for nested schema](#nestedatt--rules))
 
 <a id="nestedatt--evaluation"></a>
 ### Nested Schema for `evaluation`

docs/resources/scorecard.md

@@ -19,7 +19,7 @@ Scorecard Entity
 
 - `ladder` (Attributes) Ladder of the scorecard. (see [below for nested schema](#nestedatt--ladder))
 - `name` (String) Name of the scorecard.
-- `rules` (Attributes List) Rules of the scorecard. (see [below for nested schema](#nestedatt--rules))
+- `rules` (Attributes Set) Rules of the scorecard. (see [below for nested schema](#nestedatt--rules))
 - `tag` (String) Unique identifier for the scorecard.
 
 ### Optional

internal/provider/scorecard_data_source.go

@@ -81,7 +81,7 @@ func (d *ScorecardDataSource) Schema(ctx context.Context, req datasource.SchemaR
 					},
 				},
 			},
-			"rules": schema.ListNestedAttribute{
+			"rules": schema.SetNestedAttribute{
 				MarkdownDescription: "Rules of the scorecard.",
 				Computed:            true,
 				NestedObject: schema.NestedAttributeObject{

internal/provider/scorecard_resource.go

@@ -84,7 +84,7 @@ func (r *ScorecardResource) Schema(ctx context.Context, req resource.SchemaReque
 					},
 				},
 			},
-			"rules": schema.ListNestedAttribute{
+			"rules": schema.SetNestedAttribute{
 				MarkdownDescription: "Rules of the scorecard.",
 				Required:            true,
 				NestedObject: schema.NestedAttributeObject{