From 09c9a7283a9fa8539d09afab3375dcd0bce8b91d Mon Sep 17 00:00:00 2001 From: jillianwilson Date: Wed, 15 May 2024 18:51:22 -0300 Subject: [PATCH 1/4] Preparing release 2.0.0 --- .VERSION | 2 +- CHANGELOG.md | 166 ++++++++++++++++++++++++++++++++++++--------------- 2 files changed, 118 insertions(+), 50 deletions(-) diff --git a/.VERSION b/.VERSION index 3c80e4f0..359a5b95 100644 --- a/.VERSION +++ b/.VERSION @@ -1 +1 @@ -1.4.3 \ No newline at end of file +2.0.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 431fa3b3..c94a5c5a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,160 +1,228 @@ -[//]: # (START/LATEST) +[//]: # "START/LATEST" + # Latest ## Features - * A user-friendly description of a new feature. {issue-number} + +- A user-friendly description of a new feature. {issue-number} + +## Fixes + +- A user-friendly description of a fix. {issue-number} + +## Security + +- A user-friendly description of a security fix. {issue-number} + +--- + +[//]: # "START/v2.0.0" + +# v2.0.0 + +## Features + +- Added support for `Secure Note` items. {149} +- Added `note_value` attribute representing a 1Password Item's `notes` field. {57} ## Fixes - * A user-friendly description of a fix. {issue-number} + +- The data handling is more robust, making it less prone to errors and inconsistencies. {157,146} +- CLI and Connect clients now have a more consistent behavior. +- Fields of type `OTP` are better handled when user provides a custom ID for them. Terraform will throw an error if the custom ID doesn't have the `TOTP_` prefix, which is required for this field type. +- The values that are generated will only show in the plan to be recomputed when the recipe is changed or the value is explicitly set. +- When fetching Database items from 1Password, the `server` field (previously known as `hostname`) will populate the Terraform `hostname` attribute. This ensures that the data from new Database items is mapped as expected. {76} +- Vault description is now fetched when getting a vault from 1Password by name and the provider was configured to use the CLI client. +- Generated values (using a recipe) are now regenerated when the recipe is changed. +- Tag ordering mismatch between Terraform state and 1Password no longer causes a change if the tags are the same. The mismatch can be caused by 1Password storing the tags in alphabetical order. {155} ## Security - * A user-friendly description of a security fix. {issue-number} + +- Migration to Terraform Provider Framework addressed an issue in the terraform-plugin-sdk where it is possible that sensitive data pulled from 1Password items can be shown in plaintext when a user runs `terraform plan`. This only affects the sensitive data pulled from custom sections within 1Password items that aren’t marked as sensitive in the terraform plan. This also applies to third-party providers that don’t treat the data as sensitive. {#167} --- -[//]: # (START/v1.4.3) +[//]: # "START/v1.4.3" + # v1.4.3 ## Fixes - * Pass proper user agent info to the CLI. {#124} + +- Pass proper user agent info to the CLI. {#124} --- -[//]: # (START/v1.4.2) +[//]: # "START/v1.4.2" + # v1.4.2 ## Fixes - * Field of type 'DATE' updates item even if there were no changes. {#137} + +- Field of type 'DATE' updates item even if there were no changes. {#137} ## Security - * Update dependencies with security vulnerabilities to patched versions. {#144} + +- Update dependencies with security vulnerabilities to patched versions. {#144} --- -[//]: # (START/v1.4.1) +[//]: # "START/v1.4.1" + # v1.4.1 ## Features - * Using provider on Terraform Cloud. {#116} + +- Using provider on Terraform Cloud. {#116} ## Fixes - * Terraform cannot create items with the password we provide in the code. {#128} + +- Terraform cannot create items with the password we provide in the code. {#128} --- -[//]: # (START/v1.4.1-beta01) +[//]: # "START/v1.4.1-beta01" + # v1.4.1-beta01 ## Fixes -* Using provider on Terraform Cloud. {#116} + +- Using provider on Terraform Cloud. {#116} --- -[//]: # (START/v1.4.0) +[//]: # "START/v1.4.0" + # v1.4.0 ## Features - * Authenticate 1Password CLI with biometric unlock using user account. {#113} + +- Authenticate 1Password CLI with biometric unlock using user account. {#113} ## Fixes - * Retry CLI request in case of 409 Conflict error. {#108} - * Update documentation. {#115} + +- Retry CLI request in case of 409 Conflict error. {#108} +- Update documentation. {#115} --- -[//]: # (START/v1.3.1) +[//]: # "START/v1.3.1" + # v1.3.1 ## Fixes - * Update documentation to mention that the provider supports Service Accounts. {#106} + +- Update documentation to mention that the provider supports Service Accounts. {#106} --- -[//]: # (START/v1.3.0) +[//]: # "START/v1.3.0" + # v1.3.0 ## Features - * Add Service Accounts support. Credits to @tim-oster for the contribution! {#79} - * Add debugging support. {#102} + +- Add Service Accounts support. Credits to @tim-oster for the contribution! {#79} +- Add debugging support. {#102} ## Security - * Update dependencies with security vulnerabilities to patched versions. {#104, #112} + +- Update dependencies with security vulnerabilities to patched versions. {#104, #112} --- -[//]: # (START/v1.2.1) +[//]: # "START/v1.2.1" + # v1.2.1 ## Fixes - * Fix item creation with sections. {#96} + +- Fix item creation with sections. {#96} --- -[//]: # (START/v1.2.0) +[//]: # "START/v1.2.0" + # v1.2.0 ## Features - * Updating go version to 1.20 - * Updating to use version 1.5.1 of the Connect SDK. + +- Updating go version to 1.20 +- Updating to use version 1.5.1 of the Connect SDK. ## Fixes - * Improved sanitization for use with Github action. - * Terraform provider no longer lowercases item label. {#59} + +- Improved sanitization for use with Github action. +- Terraform provider no longer lowercases item label. {#59} ## Security - * Updated dependencies with secuirty vulnerbilities to patched versions + +- Updated dependencies with secuirty vulnerbilities to patched versions --- -[//]: # (START/v1.1.4) +[//]: # "START/v1.1.4" + # v1.1.4 ## Fixes - * Fix (T)OTP field type. {#54} + +- Fix (T)OTP field type. {#54} --- -[//]: # (START/v1.1.3) +[//]: # "START/v1.1.3" + # v1.1.3 ## Fixes - * Setting the provider's `token` field through Terraform's built-in prompt no longer leads to an error about the `url` not beign set. {#46} - * The purpose of the `id` and `uuid` fields of the item and vault data-source is now correctly described in the docs. {#42} - * The `tags` field for the item data-source is now correctly identified as an output. + +- Setting the provider's `token` field through Terraform's built-in prompt no longer leads to an error about the `url` not beign set. {#46} +- The purpose of the `id` and `uuid` fields of the item and vault data-source is now correctly described in the docs. {#42} +- The `tags` field for the item data-source is now correctly identified as an output. --- -[//]: # (START/v1.1.2) +[//]: # "START/v1.1.2" + # v1.1.2 + ## Fixes - * Improve error messages. -[//]: # (START/v1.1.1) +- Improve error messages. + +[//]: # "START/v1.1.1" + # v1.1.1 ## Features - * This release includes a binary for `darwin/arm64`. {#35} + +- This release includes a binary for `darwin/arm64`. {#35} --- -[//]: # (START/v1.1.0) +[//]: # "START/v1.1.0" + # v1.1.0 ## Features - * Adds the `onepassword_vault` data source that can be used to look up a vault by its name or uuid. {#25} - * The `onepassword_item` data source can now be used by setting the `title` instead of the `uuid` field. {#25} - * The documentation now clearly mentions that the Connect Token can also be provided thorugh `$OP_CONNECT_TOKEN`. + +- Adds the `onepassword_vault` data source that can be used to look up a vault by its name or uuid. {#25} +- The `onepassword_item` data source can now be used by setting the `title` instead of the `uuid` field. {#25} +- The documentation now clearly mentions that the Connect Token can also be provided thorugh `$OP_CONNECT_TOKEN`. ## Fixes - * The `id` and `uuid` fields of the `onepassword_item` resource are now correctly designated as outputs. + +- The `id` and `uuid` fields of the `onepassword_item` resource are now correctly designated as outputs. --- -[//]: # (START/v1.0.2) +[//]: # "START/v1.0.2" + # v1.0.2 ## Features - * Documentation for the provider is now published on the Terraform Registry. {#8} + +- Documentation for the provider is now published on the Terraform Registry. {#8} --- From f997854c7d2b211df2e4251c27797cbd0e8646e7 Mon Sep 17 00:00:00 2001 From: jillianwilson Date: Wed, 15 May 2024 18:57:42 -0300 Subject: [PATCH 2/4] Adding # to issue numbers in changelog --- CHANGELOG.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c94a5c5a..f41ef86c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,19 +22,19 @@ ## Features -- Added support for `Secure Note` items. {149} -- Added `note_value` attribute representing a 1Password Item's `notes` field. {57} +- Added support for `Secure Note` items. {#149} +- Added `note_value` attribute representing a 1Password Item's `notes` field. {#57} ## Fixes -- The data handling is more robust, making it less prone to errors and inconsistencies. {157,146} +- The data handling is more robust, making it less prone to errors and inconsistencies. {#157,#146} - CLI and Connect clients now have a more consistent behavior. - Fields of type `OTP` are better handled when user provides a custom ID for them. Terraform will throw an error if the custom ID doesn't have the `TOTP_` prefix, which is required for this field type. - The values that are generated will only show in the plan to be recomputed when the recipe is changed or the value is explicitly set. -- When fetching Database items from 1Password, the `server` field (previously known as `hostname`) will populate the Terraform `hostname` attribute. This ensures that the data from new Database items is mapped as expected. {76} +- When fetching Database items from 1Password, the `server` field (previously known as `hostname`) will populate the Terraform `hostname` attribute. This ensures that the data from new Database items is mapped as expected. {#76} - Vault description is now fetched when getting a vault from 1Password by name and the provider was configured to use the CLI client. - Generated values (using a recipe) are now regenerated when the recipe is changed. -- Tag ordering mismatch between Terraform state and 1Password no longer causes a change if the tags are the same. The mismatch can be caused by 1Password storing the tags in alphabetical order. {155} +- Tag ordering mismatch between Terraform state and 1Password no longer causes a change if the tags are the same. The mismatch can be caused by 1Password storing the tags in alphabetical order. {#155} ## Security From c57cde6e181d2de583bc1791e587905975cbe44b Mon Sep 17 00:00:00 2001 From: jillianwilson Date: Wed, 15 May 2024 19:05:46 -0300 Subject: [PATCH 3/4] Remove autofromatting of changelog for v2.0.0 --- CHANGELOG.md | 168 +++++++++++++++++++-------------------------------- 1 file changed, 61 insertions(+), 107 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f41ef86c..c4315d32 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,228 +1,182 @@ -[//]: # "START/LATEST" - +[//]: # (START/LATEST) # Latest ## Features - -- A user-friendly description of a new feature. {issue-number} + * A user-friendly description of a new feature. {issue-number} ## Fixes - -- A user-friendly description of a fix. {issue-number} + * A user-friendly description of a fix. {issue-number} ## Security - -- A user-friendly description of a security fix. {issue-number} + * A user-friendly description of a security fix. {issue-number} --- -[//]: # "START/v2.0.0" - +[//]: # (START/v2.0.0) # v2.0.0 ## Features - -- Added support for `Secure Note` items. {#149} -- Added `note_value` attribute representing a 1Password Item's `notes` field. {#57} + * Added support for `Secure Note` items. {#149} + * Added `note_value` attribute representing a 1Password Item's `notes` field. {#57} ## Fixes - -- The data handling is more robust, making it less prone to errors and inconsistencies. {#157,#146} -- CLI and Connect clients now have a more consistent behavior. -- Fields of type `OTP` are better handled when user provides a custom ID for them. Terraform will throw an error if the custom ID doesn't have the `TOTP_` prefix, which is required for this field type. -- The values that are generated will only show in the plan to be recomputed when the recipe is changed or the value is explicitly set. -- When fetching Database items from 1Password, the `server` field (previously known as `hostname`) will populate the Terraform `hostname` attribute. This ensures that the data from new Database items is mapped as expected. {#76} -- Vault description is now fetched when getting a vault from 1Password by name and the provider was configured to use the CLI client. -- Generated values (using a recipe) are now regenerated when the recipe is changed. -- Tag ordering mismatch between Terraform state and 1Password no longer causes a change if the tags are the same. The mismatch can be caused by 1Password storing the tags in alphabetical order. {#155} + * The data handling is more robust, making it less prone to errors and inconsistencies. {#157,#146} + * CLI and Connect clients now have a more consistent behavior. + * Fields of type `OTP` are better handled when user provides a custom ID for them. Terraform will throw an error if the custom ID doesn't have the `TOTP_` prefix, which is required for this field type. + * The values that are generated will only show in the plan to be recomputed when the recipe is changed or the value is explicitly set. + * When fetching Database items from 1Password, the `server` field (previously known as `hostname`) will populate the Terraform `hostname` attribute. This ensures that the data from new Database items is mapped as expected. {#76} + * Vault description is now fetched when getting a vault from 1Password by name and the provider was configured to use the CLI client. + * Generated values (using a recipe) are now regenerated when the recipe is changed. + * Tag ordering mismatch between Terraform state and 1Password no longer causes a change if the tags are the same. The mismatch can be caused by 1Password storing the tags in alphabetical order. {#155} ## Security - -- Migration to Terraform Provider Framework addressed an issue in the terraform-plugin-sdk where it is possible that sensitive data pulled from 1Password items can be shown in plaintext when a user runs `terraform plan`. This only affects the sensitive data pulled from custom sections within 1Password items that aren’t marked as sensitive in the terraform plan. This also applies to third-party providers that don’t treat the data as sensitive. {#167} + * Migration to Terraform Provider Framework addressed an issue in the terraform-plugin-sdk where it is possible that sensitive data pulled from 1Password items can be shown in plaintext when a user runs `terraform plan`. This only affects the sensitive data pulled from custom sections within 1Password items that aren’t marked as sensitive in the terraform plan. This also applies to third-party providers that don’t treat the data as sensitive. {#167} --- -[//]: # "START/v1.4.3" - +[//]: # (START/v1.4.3) # v1.4.3 ## Fixes - -- Pass proper user agent info to the CLI. {#124} + * Pass proper user agent info to the CLI. {#124} --- -[//]: # "START/v1.4.2" - +[//]: # (START/v1.4.2) # v1.4.2 ## Fixes - -- Field of type 'DATE' updates item even if there were no changes. {#137} + * Field of type 'DATE' updates item even if there were no changes. {#137} ## Security - -- Update dependencies with security vulnerabilities to patched versions. {#144} + * Update dependencies with security vulnerabilities to patched versions. {#144} --- -[//]: # "START/v1.4.1" - +[//]: # (START/v1.4.1) # v1.4.1 ## Features - -- Using provider on Terraform Cloud. {#116} + * Using provider on Terraform Cloud. {#116} ## Fixes - -- Terraform cannot create items with the password we provide in the code. {#128} + * Terraform cannot create items with the password we provide in the code. {#128} --- -[//]: # "START/v1.4.1-beta01" - +[//]: # (START/v1.4.1-beta01) # v1.4.1-beta01 ## Fixes - -- Using provider on Terraform Cloud. {#116} +* Using provider on Terraform Cloud. {#116} --- -[//]: # "START/v1.4.0" - +[//]: # (START/v1.4.0) # v1.4.0 ## Features - -- Authenticate 1Password CLI with biometric unlock using user account. {#113} + * Authenticate 1Password CLI with biometric unlock using user account. {#113} ## Fixes - -- Retry CLI request in case of 409 Conflict error. {#108} -- Update documentation. {#115} + * Retry CLI request in case of 409 Conflict error. {#108} + * Update documentation. {#115} --- -[//]: # "START/v1.3.1" - +[//]: # (START/v1.3.1) # v1.3.1 ## Fixes - -- Update documentation to mention that the provider supports Service Accounts. {#106} + * Update documentation to mention that the provider supports Service Accounts. {#106} --- -[//]: # "START/v1.3.0" - +[//]: # (START/v1.3.0) # v1.3.0 ## Features - -- Add Service Accounts support. Credits to @tim-oster for the contribution! {#79} -- Add debugging support. {#102} + * Add Service Accounts support. Credits to @tim-oster for the contribution! {#79} + * Add debugging support. {#102} ## Security - -- Update dependencies with security vulnerabilities to patched versions. {#104, #112} + * Update dependencies with security vulnerabilities to patched versions. {#104, #112} --- -[//]: # "START/v1.2.1" - +[//]: # (START/v1.2.1) # v1.2.1 ## Fixes - -- Fix item creation with sections. {#96} + * Fix item creation with sections. {#96} --- -[//]: # "START/v1.2.0" - +[//]: # (START/v1.2.0) # v1.2.0 ## Features - -- Updating go version to 1.20 -- Updating to use version 1.5.1 of the Connect SDK. + * Updating go version to 1.20 + * Updating to use version 1.5.1 of the Connect SDK. ## Fixes - -- Improved sanitization for use with Github action. -- Terraform provider no longer lowercases item label. {#59} + * Improved sanitization for use with Github action. + * Terraform provider no longer lowercases item label. {#59} ## Security - -- Updated dependencies with secuirty vulnerbilities to patched versions + * Updated dependencies with secuirty vulnerbilities to patched versions --- -[//]: # "START/v1.1.4" - +[//]: # (START/v1.1.4) # v1.1.4 ## Fixes - -- Fix (T)OTP field type. {#54} + * Fix (T)OTP field type. {#54} --- -[//]: # "START/v1.1.3" - +[//]: # (START/v1.1.3) # v1.1.3 ## Fixes - -- Setting the provider's `token` field through Terraform's built-in prompt no longer leads to an error about the `url` not beign set. {#46} -- The purpose of the `id` and `uuid` fields of the item and vault data-source is now correctly described in the docs. {#42} -- The `tags` field for the item data-source is now correctly identified as an output. + * Setting the provider's `token` field through Terraform's built-in prompt no longer leads to an error about the `url` not beign set. {#46} + * The purpose of the `id` and `uuid` fields of the item and vault data-source is now correctly described in the docs. {#42} + * The `tags` field for the item data-source is now correctly identified as an output. --- -[//]: # "START/v1.1.2" - +[//]: # (START/v1.1.2) # v1.1.2 - ## Fixes + * Improve error messages. -- Improve error messages. - -[//]: # "START/v1.1.1" - +[//]: # (START/v1.1.1) # v1.1.1 ## Features - -- This release includes a binary for `darwin/arm64`. {#35} + * This release includes a binary for `darwin/arm64`. {#35} --- -[//]: # "START/v1.1.0" - +[//]: # (START/v1.1.0) # v1.1.0 ## Features - -- Adds the `onepassword_vault` data source that can be used to look up a vault by its name or uuid. {#25} -- The `onepassword_item` data source can now be used by setting the `title` instead of the `uuid` field. {#25} -- The documentation now clearly mentions that the Connect Token can also be provided thorugh `$OP_CONNECT_TOKEN`. + * Adds the `onepassword_vault` data source that can be used to look up a vault by its name or uuid. {#25} + * The `onepassword_item` data source can now be used by setting the `title` instead of the `uuid` field. {#25} + * The documentation now clearly mentions that the Connect Token can also be provided thorugh `$OP_CONNECT_TOKEN`. ## Fixes - -- The `id` and `uuid` fields of the `onepassword_item` resource are now correctly designated as outputs. + * The `id` and `uuid` fields of the `onepassword_item` resource are now correctly designated as outputs. --- -[//]: # "START/v1.0.2" - +[//]: # (START/v1.0.2) # v1.0.2 ## Features - -- Documentation for the provider is now published on the Terraform Registry. {#8} + * Documentation for the provider is now published on the Terraform Registry. {#8} --- From bb8bbc726a36903d8483533d4f11bdb5ee13d11c Mon Sep 17 00:00:00 2001 From: jillianwilson Date: Wed, 15 May 2024 19:09:59 -0300 Subject: [PATCH 4/4] Updating provider version in version.go to 2.0.0 --- version/version.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/version/version.go b/version/version.go index fb5673d8..d9582432 100644 --- a/version/version.go +++ b/version/version.go @@ -2,5 +2,5 @@ package version var ( // ProviderVersion is set during release. - ProviderVersion = "1.4.3" + ProviderVersion = "2.0.0" )