Fnm/soft delete retention_policy

.gitignore

@@ -56,4 +56,4 @@ terraform/**/.terraform/*
 # Ignore the test results file
 results.xml
 
-.DS_Store
+.DS_Store

docs/data-sources/lifecycles.md

@@ -46,9 +46,9 @@ Read-Only:
 - `id` (String) The ID of the lifecycle.
 - `name` (String) The name of the lifecycle.
 - `phase` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--phase))
-- `release_retention_policy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--release_retention_policy))
+- `release_retention_with_strategy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--release_retention_with_strategy))
 - `space_id` (String) The space ID associated with this lifecycle.
-- `tentacle_retention_policy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--tentacle_retention_policy))
+- `tentacle_retention_with_strategy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--tentacle_retention_with_strategy))
 
 <a id="nestedatt--lifecycles--phase"></a>
 ### Nested Schema for `lifecycles.phase`
@@ -62,47 +62,59 @@ Read-Only:
 - `minimum_environments_before_promotion` (Number) The minimum number of environments before promotion.
 - `name` (String) The name of the phase.
 - `optional_deployment_targets` (List of String) The optional deployment targets for this phase.
-- `release_retention_policy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--phase--release_retention_policy))
-- `tentacle_retention_policy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--phase--tentacle_retention_policy))
+- `release_retention_with_strategy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--phase--release_retention_with_strategy))
+- `tentacle_retention_with_strategy` (Attributes List) (see [below for nested schema](#nestedatt--lifecycles--phase--tentacle_retention_with_strategy))
 
-<a id="nestedatt--lifecycles--phase--release_retention_policy"></a>
-### Nested Schema for `lifecycles.phase.release_retention_policy`
+<a id="nestedatt--lifecycles--phase--release_retention_with_strategy"></a>
+### Nested Schema for `lifecycles.phase.release_retention_with_strategy`
 
 Read-Only:
 
-- `quantity_to_keep` (Number) The quantity of releases to keep.
-- `should_keep_forever` (Boolean) Whether releases should be kept forever.
-- `unit` (String) The unit of time for the retention policy.
+- `quantity_to_keep` (Number) The unit for `quantity_to_keep`. Dismiss when `strategy` is "Forever" or "Default".
+- `strategy` (String) The retention policy strategy. Can be "Default", "Forever", and "Count". 
+  - "Default" indicates retention is set by the Space Default retention policy for lifecycles 
+  - "Forever" indicates releases are never deleted 
+  - "Count" indicates releases are kept according to `unit` and `quantity_to_keep`
+- `unit` (String) The number of units to keep. Dismiss when `strategy` is "Forever" or "Default".
 
 
-<a id="nestedatt--lifecycles--phase--tentacle_retention_policy"></a>
-### Nested Schema for `lifecycles.phase.tentacle_retention_policy`
+<a id="nestedatt--lifecycles--phase--tentacle_retention_with_strategy"></a>
+### Nested Schema for `lifecycles.phase.tentacle_retention_with_strategy`
 
 Read-Only:
 
-- `quantity_to_keep` (Number) The quantity of releases to keep.
-- `should_keep_forever` (Boolean) Whether releases should be kept forever.
-- `unit` (String) The unit of time for the retention policy.
+- `quantity_to_keep` (Number) The unit for `quantity_to_keep`. Dismiss when `strategy` is "Forever" or "Default".
+- `strategy` (String) The retention policy strategy. Can be "Default", "Forever", and "Count". 
+  - "Default" indicates retention is set by the Space Default retention policy for lifecycles 
+  - "Forever" indicates releases are never deleted 
+  - "Count" indicates releases are kept according to `unit` and `quantity_to_keep`
+- `unit` (String) The number of units to keep. Dismiss when `strategy` is "Forever" or "Default".
 
 
 
-<a id="nestedatt--lifecycles--release_retention_policy"></a>
-### Nested Schema for `lifecycles.release_retention_policy`
+<a id="nestedatt--lifecycles--release_retention_with_strategy"></a>
+### Nested Schema for `lifecycles.release_retention_with_strategy`
 
 Read-Only:
 
-- `quantity_to_keep` (Number) The quantity of releases to keep.
-- `should_keep_forever` (Boolean) Whether releases should be kept forever.
-- `unit` (String) The unit of time for the retention policy.
+- `quantity_to_keep` (Number) The unit for `quantity_to_keep`. Dismiss when `strategy` is "Forever" or "Default".
+- `strategy` (String) The retention policy strategy. Can be "Default", "Forever", and "Count". 
+  - "Default" indicates retention is set by the Space Default retention policy for lifecycles 
+  - "Forever" indicates releases are never deleted 
+  - "Count" indicates releases are kept according to `unit` and `quantity_to_keep`
+- `unit` (String) The number of units to keep. Dismiss when `strategy` is "Forever" or "Default".
 
 
-<a id="nestedatt--lifecycles--tentacle_retention_policy"></a>
-### Nested Schema for `lifecycles.tentacle_retention_policy`
+<a id="nestedatt--lifecycles--tentacle_retention_with_strategy"></a>
+### Nested Schema for `lifecycles.tentacle_retention_with_strategy`
 
 Read-Only:
 
-- `quantity_to_keep` (Number) The quantity of releases to keep.
-- `should_keep_forever` (Boolean) Whether releases should be kept forever.
-- `unit` (String) The unit of time for the retention policy.
+- `quantity_to_keep` (Number) The unit for `quantity_to_keep`. Dismiss when `strategy` is "Forever" or "Default".
+- `strategy` (String) The retention policy strategy. Can be "Default", "Forever", and "Count". 
+  - "Default" indicates retention is set by the Space Default retention policy for lifecycles 
+  - "Forever" indicates releases are never deleted 
+  - "Count" indicates releases are kept according to `unit` and `quantity_to_keep`
+- `unit` (String) The number of units to keep. Dismiss when `strategy` is "Forever" or "Default".
 
 

docs/resources/lifecycle.md

@@ -3,12 +3,23 @@ page_title: "octopusdeploy_lifecycle Resource - terraform-provider-octopusdeploy
 subcategory: ""
 description: |-
   This resource manages lifecycles in Octopus Deploy.
+  Lifecycle retention is set using either the retention_policy and retention_with_strategy blocks.
+  - When using an octopus version prior to 2025.3
+      - the release_retention_policy and tentacle_retention_policy blocks are to be used
+  - when using an octopus version 2025.3 or later
+      - the release_retention_with_strategy and tentacle_retention_with_strategy blocks are reccommended for use
 ---
 
 # octopusdeploy_lifecycle (Resource)
 
 This resource manages lifecycles in Octopus Deploy.
 
+Lifecycle retention is set using either the `retention_policy` and `retention_with_strategy` blocks.
+- When using an octopus version prior to `2025.3`
+	- the `release_retention_policy` and `tentacle_retention_policy` blocks are to be used
+- when using an octopus version `2025.3` or later
+	- the `release_retention_with_strategy` and `tentacle_retention_with_strategy` blocks are reccommended for use
+
 ## Example Usage
 
 ```terraform
@@ -64,9 +75,13 @@ resource "octopusdeploy_lifecycle" "example" {
 
 - `description` (String) The description of this lifecycle.
 - `phase` (Block List) Defines a phase in the lifecycle. (see [below for nested schema](#nestedblock--phase))
-- `release_retention_policy` (Block List) Defines the retention policy for releases or tentacles. (see [below for nested schema](#nestedblock--release_retention_policy))
+- `release_retention_with_strategy` (Block List) Defines the retention policy for releases or tentacles.
+	- When this block is not included, the phase inherits the retention from the lifecycle 
+ 	- This block may only be used on Octopus server 2025.3 or later. (see [below for nested schema](#nestedblock--release_retention_with_strategy))
 - `space_id` (String) The space ID associated with this resource.
-- `tentacle_retention_policy` (Block List) Defines the retention policy for releases or tentacles. (see [below for nested schema](#nestedblock--tentacle_retention_policy))
+- `tentacle_retention_with_strategy` (Block List) Defines the retention policy for releases or tentacles.
+	- When this block is not included, the phase inherits the retention from the lifecycle 
+ 	- This block may only be used on Octopus server 2025.3 or later. (see [below for nested schema](#nestedblock--tentacle_retention_with_strategy))
 
 ### Read-Only
 
@@ -87,48 +102,76 @@ Optional:
 - `is_priority_phase` (Boolean) Deployments will be prioritized in this phase
 - `minimum_environments_before_promotion` (Number) The number of units required before a release can enter the next phase. If 0, all environments are required.
 - `optional_deployment_targets` (List of String) Environment IDs in this phase that a release can be deployed to, but is not automatically deployed to
-- `release_retention_policy` (Block List) Defines the retention policy for releases or tentacles. (see [below for nested schema](#nestedblock--phase--release_retention_policy))
-- `tentacle_retention_policy` (Block List) Defines the retention policy for releases or tentacles. (see [below for nested schema](#nestedblock--phase--tentacle_retention_policy))
+- `release_retention_with_strategy` (Block List) Defines the retention policy for releases or tentacles.
+	- When this block is not included, the phase inherits the retention from the lifecycle 
+ 	- This block may only be used on Octopus server 2025.3 or later. (see [below for nested schema](#nestedblock--phase--release_retention_with_strategy))
+- `tentacle_retention_with_strategy` (Block List) Defines the retention policy for releases or tentacles.
+	- When this block is not included, the phase inherits the retention from the lifecycle 
+ 	- This block may only be used on Octopus server 2025.3 or later. (see [below for nested schema](#nestedblock--phase--tentacle_retention_with_strategy))
+
+<a id="nestedblock--phase--release_retention_with_strategy"></a>
+### Nested Schema for `phase.release_retention_with_strategy`
+
+Required:
 
-<a id="nestedblock--phase--release_retention_policy"></a>
-### Nested Schema for `phase.release_retention_policy`
+- `strategy` (String) How retention will be set. Valid strategies are `Default`, `Forever`, and `Count`. The default value is `Default`.
+  - `strategy = "Default"`, is used if the retention is set by the space-wide default lifecycle retention policy. When `Default` is used, no other attributes can be set since the specific retention policy is no longer defined within this lifecycle.
+  - `strategy = "Forever"`, is used if items within this lifecycle should never be deleted.
+  - `strategy = "Count"`, is used if a specific number of days/releases should be kept.
 
 Optional:
 
-- `quantity_to_keep` (Number) The number of days/releases to keep. The default value is 30. If 0 then all are kept.
-- `should_keep_forever` (Boolean) Indicates if items should never be deleted. The default value is false.
-- `unit` (String) The unit of quantity to keep. Valid units are Days or Items. The default value is Days.
+- `quantity_to_keep` (Number) The number of days/releases to keep.
+- `unit` (String) The unit of quantity to keep. Valid units are Days or Items.
 
 
-<a id="nestedblock--phase--tentacle_retention_policy"></a>
-### Nested Schema for `phase.tentacle_retention_policy`
+<a id="nestedblock--phase--tentacle_retention_with_strategy"></a>
+### Nested Schema for `phase.tentacle_retention_with_strategy`
+
+Required:
+
+- `strategy` (String) How retention will be set. Valid strategies are `Default`, `Forever`, and `Count`. The default value is `Default`.
+  - `strategy = "Default"`, is used if the retention is set by the space-wide default lifecycle retention policy. When `Default` is used, no other attributes can be set since the specific retention policy is no longer defined within this lifecycle.
+  - `strategy = "Forever"`, is used if items within this lifecycle should never be deleted.
+  - `strategy = "Count"`, is used if a specific number of days/releases should be kept.
 
 Optional:
 
-- `quantity_to_keep` (Number) The number of days/releases to keep. The default value is 30. If 0 then all are kept.
-- `should_keep_forever` (Boolean) Indicates if items should never be deleted. The default value is false.
-- `unit` (String) The unit of quantity to keep. Valid units are Days or Items. The default value is Days.
+- `quantity_to_keep` (Number) The number of days/releases to keep.
+- `unit` (String) The unit of quantity to keep. Valid units are Days or Items.
 
 
 
-<a id="nestedblock--release_retention_policy"></a>
-### Nested Schema for `release_retention_policy`
+<a id="nestedblock--release_retention_with_strategy"></a>
+### Nested Schema for `release_retention_with_strategy`
+
+Required:
+
+- `strategy` (String) How retention will be set. Valid strategies are `Default`, `Forever`, and `Count`. The default value is `Default`.
+  - `strategy = "Default"`, is used if the retention is set by the space-wide default lifecycle retention policy. When `Default` is used, no other attributes can be set since the specific retention policy is no longer defined within this lifecycle.
+  - `strategy = "Forever"`, is used if items within this lifecycle should never be deleted.
+  - `strategy = "Count"`, is used if a specific number of days/releases should be kept.
 
 Optional:
 
-- `quantity_to_keep` (Number) The number of days/releases to keep. The default value is 30. If 0 then all are kept.
-- `should_keep_forever` (Boolean) Indicates if items should never be deleted. The default value is false.
-- `unit` (String) The unit of quantity to keep. Valid units are Days or Items. The default value is Days.
+- `quantity_to_keep` (Number) The number of days/releases to keep.
+- `unit` (String) The unit of quantity to keep. Valid units are Days or Items.
 
 
-<a id="nestedblock--tentacle_retention_policy"></a>
-### Nested Schema for `tentacle_retention_policy`
+<a id="nestedblock--tentacle_retention_with_strategy"></a>
+### Nested Schema for `tentacle_retention_with_strategy`
+
+Required:
+
+- `strategy` (String) How retention will be set. Valid strategies are `Default`, `Forever`, and `Count`. The default value is `Default`.
+  - `strategy = "Default"`, is used if the retention is set by the space-wide default lifecycle retention policy. When `Default` is used, no other attributes can be set since the specific retention policy is no longer defined within this lifecycle.
+  - `strategy = "Forever"`, is used if items within this lifecycle should never be deleted.
+  - `strategy = "Count"`, is used if a specific number of days/releases should be kept.
 
 Optional:
 
-- `quantity_to_keep` (Number) The number of days/releases to keep. The default value is 30. If 0 then all are kept.
-- `should_keep_forever` (Boolean) Indicates if items should never be deleted. The default value is false.
-- `unit` (String) The unit of quantity to keep. Valid units are Days or Items. The default value is Days.
+- `quantity_to_keep` (Number) The number of days/releases to keep.
+- `unit` (String) The unit of quantity to keep. Valid units are Days or Items.
 
 ## Import
 

go.mod

@@ -149,3 +149,4 @@ require (
 	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
+