From 1d5cf8e4e065b2320e96d4644358a8da0b3687d7 Mon Sep 17 00:00:00 2001 From: domenicsim1 Date: Thu, 14 Nov 2024 10:13:41 +1100 Subject: [PATCH] chore: update README about framework migration. --- CONTRIBUTING.md | 8 -------- README.md | 8 ++++++++ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a506f25..eec0af7d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,14 +8,6 @@ This guide provides an overview of the contribution workflow from opening an iss This project is built, tested, and released by workflows defined in GitHub Actions (see [Actions](/actions/) for more information). Release management is controlled through [Release-Please](https://github.com/googleapis/release-please). Please use conventional commits. -### Create a New Resource - -The provider is currently undergoing migration from Terraform SDK to Terraform Plugin Framework. Ensure all **new** resources are created under the `octopusdeploy-framework` directory using existing resources within the `octopusdeploy-framework` directory as a guideline. - -All new resources need an acceptance test that will ensure the lifecycle of the resource works correctly this includes Create, Read, Update and Delete. - -Please avoid using blocks in favour of nested attribute types. Blocks are mainly used for resources migrated from SDK to maintain backwards compatability. - ### Issues We :heart: feedback! Submitting an issue (i.e. feature, bug) is the best way to document things your experience with this project. For example, if there's a feature missing or there's behavior that doesn't match your expectations then we strongly encourage you to submit an issue. That way, contributors can track them and have interested folks (like you) by notified if/when they're resolved. diff --git a/README.md b/README.md index 06547c73..55aa5a43 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,14 @@ Terraform will scan the local plugins folder directory structure (first) to qual :warning: The `version` number specified in your Terraform configuration MUST match the version number specified in the Makefile. Futhermore, this version MUST either be incremented for each local re-build; otherwise, Terraform will use the cached version of the provider in the `.terraform` folder. Alternatively, you can simply delete the folder and re-run the `terraform init` command. +## Create a New Resource + +The provider is currently undergoing migration from Terraform SDK to Terraform Plugin Framework. Ensure all **new** resources are created under the `octopusdeploy-framework` directory using existing resources within the `octopusdeploy-framework` directory as a guideline. + +All new resources need an acceptance test that will ensure the lifecycle of the resource works correctly this includes Create, Read, Update and Delete. + +Please avoid using blocks in favour of nested attribute types. Blocks are mainly used for resources migrated from SDK to maintain backwards compatability. + ## Debugging If you want to debug the provider follow these steps!