From 0d9ddfa6e2f743b66f9ad4958cc49092e75f2caa Mon Sep 17 00:00:00 2001 From: domenicsim1 Date: Thu, 14 Nov 2024 10:05:24 +1100 Subject: [PATCH 1/4] chore: update README and CONTRIBUTING about framework migration. --- CONTRIBUTING.md | 10 +++++++++- README.md | 3 ++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8744f2ba..4a506f256 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,15 @@ This guide provides an overview of the contribution workflow from opening an iss ## Getting Started -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). +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 diff --git a/README.md b/README.md index d00b67106..be409de1e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ ## :warning: Warning -The Terraform Provider for Octopus Deploy is under active development. Its functionalty can and will change; it is a v0.\* product until its robustness can be assured. Please be aware that types like resources can and will be modified over time. It is strongly recommended to `validate` and `plan` configuration prior to committing changes via `apply`. +The Terraform Provider for Octopus Deploy is under active development and in the process of migrating from Terraform SDK to Terraform Plugin Framework. Its functionalty can and will change; it is a v0.\* product until its robustness can be assured. Please be aware that types like resources can and will be modified over time. It is strongly recommended to `validate` and `plan` configuration prior to committing changes via `apply`. + ## About From 8781f62982618489c2fc645a32d011003f7896e0 Mon Sep 17 00:00:00 2001 From: domenicsim1 Date: Thu, 14 Nov 2024 10:05:24 +1100 Subject: [PATCH 2/4] chore: update README and CONTRIBUTING about framework migration. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index be409de1e..06547c73b 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ ## :warning: Warning -The Terraform Provider for Octopus Deploy is under active development and in the process of migrating from Terraform SDK to Terraform Plugin Framework. Its functionalty can and will change; it is a v0.\* product until its robustness can be assured. Please be aware that types like resources can and will be modified over time. It is strongly recommended to `validate` and `plan` configuration prior to committing changes via `apply`. - +The Terraform Provider for Octopus Deploy is under active development and undergoing migration from Terraform SDK to Terraform Plugin Framework. Its functionality can and will change; it is a v0.\* product until its robustness can be assured. Please be aware that types like resources can and will be modified over time. It is strongly recommended to `validate` and `plan` configuration prior to committing changes via `apply`. ## About From 1d5cf8e4e065b2320e96d4644358a8da0b3687d7 Mon Sep 17 00:00:00 2001 From: domenicsim1 Date: Thu, 14 Nov 2024 10:13:41 +1100 Subject: [PATCH 3/4] 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 4a506f256..eec0af7da 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 06547c73b..55aa5a43f 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! From 4ac5d47e0802eeb29aa0f89d9b6e2bc14625780a Mon Sep 17 00:00:00 2001 From: domenicsim1 <87625140+domenicsim1@users.noreply.github.com> Date: Thu, 14 Nov 2024 10:59:10 +1100 Subject: [PATCH 4/4] Update CONTRIBUTING.md Co-authored-by: Matt Hilton <730704+mjhilton@users.noreply.github.com> --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eec0af7da..e36f4bc1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,9 @@ This guide provides an overview of the contribution workflow from opening an iss ## Getting Started -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. +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](https://www.conventionalcommits.org/en/v1.0.0/#summary), and choose the "Squash and Merge" option to merge your PR (so we get a nice, clear Git history that makes it obvious what's changed) ### Issues