Add debug property to runbookruns deployments and execution resource

OctopusDeploy · Jan 14, 2025 · c3ac13a · c3ac13a
1 parent b536f79
commit c3ac13a
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 0 deletions.
diff --git a/...Tests/PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETCore.approved.txt b/...Tests/PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETCore.approved.txt
@@ -2865,6 +2865,7 @@ Octopus.Client.Model
     String ChannelId { get; set; }
     String Comments { get; set; }
     DateTimeOffset Created { get; set; }
+    Boolean Debug { get; set; }
     String DeployedBy { get; set; }
     String DeployedById { get; set; }
     Octopus.Client.Model.ReferenceCollection DeployedToMachineIds { get; set; }
@@ -3474,6 +3475,7 @@ Octopus.Client.Model
   {
     String Comments { get; set; }
     DateTimeOffset Created { get; set; }
+    Boolean Debug { get; set; }
     String DeployedBy { get; set; }
     String DeployedById { get; set; }
     Octopus.Client.Model.ReferenceCollection DeployedToMachineIds { get; set; }
@@ -5006,6 +5008,7 @@ Octopus.Client.Model
   class RunbookRunParameters
   {
     .ctor()
+    Nullable<Boolean> Debug { get; set; }
     String EnvironmentId { get; set; }
     String[] EnvironmentIds { get; set; }
     String[] ExcludedMachineIds { get; set; }
@@ -5042,6 +5045,7 @@ Octopus.Client.Model
     .ctor()
     String Comments { get; set; }
     DateTimeOffset Created { get; set; }
+    Boolean Debug { get; set; }
     String DeployedBy { get; set; }
     String DeployedById { get; set; }
     Octopus.Client.Model.ReferenceCollection DeployedToMachineIds { get; set; }

diff --git a/.../PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETFramework.approved.txt b/.../PublicSurfaceAreaFixture.ThePublicSurfaceAreaShouldNotRegress..NETFramework.approved.txt
@@ -2882,6 +2882,7 @@ Octopus.Client.Model
     String ChannelId { get; set; }
     String Comments { get; set; }
     DateTimeOffset Created { get; set; }
+    Boolean Debug { get; set; }
     String DeployedBy { get; set; }
     String DeployedById { get; set; }
     Octopus.Client.Model.ReferenceCollection DeployedToMachineIds { get; set; }
@@ -3491,6 +3492,7 @@ Octopus.Client.Model
   {
     String Comments { get; set; }
     DateTimeOffset Created { get; set; }
+    Boolean Debug { get; set; }
     String DeployedBy { get; set; }
     String DeployedById { get; set; }
     Octopus.Client.Model.ReferenceCollection DeployedToMachineIds { get; set; }
@@ -5025,6 +5027,7 @@ Octopus.Client.Model
   class RunbookRunParameters
   {
     .ctor()
+    Nullable<Boolean> Debug { get; set; }
     String EnvironmentId { get; set; }
     String[] EnvironmentIds { get; set; }
     String[] ExcludedMachineIds { get; set; }
@@ -5061,6 +5064,7 @@ Octopus.Client.Model
     .ctor()
     String Comments { get; set; }
     DateTimeOffset Created { get; set; }
+    Boolean Debug { get; set; }
     String DeployedBy { get; set; }
     String DeployedById { get; set; }
     Octopus.Client.Model.ReferenceCollection DeployedToMachineIds { get; set; }

diff --git a/source/Octopus.Server.Client/Model/DeploymentResource.cs b/source/Octopus.Server.Client/Model/DeploymentResource.cs
@@ -71,6 +71,12 @@ public DeploymentResource()
         /// </summary>
         [WriteableOnCreate]
         public bool UseGuidedFailure { get; set; }
+
+        /// <summary>
+        /// When enabled sets the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the runbook run
+        /// </summary>
+        [WriteableOnCreate]
+        public bool Debug { get; set; }
 
         /// <summary>
         /// One of the values from <see cref="DeploymentPriority"/>

diff --git a/source/Octopus.Server.Client/Model/IExecutionResource.cs b/source/Octopus.Server.Client/Model/IExecutionResource.cs
@@ -14,6 +14,7 @@ public interface IExecutionResource : IResource
         ReferenceCollection SpecificMachineIds { get; set; }
         ReferenceCollection ExcludedMachineIds { get; set; }
         bool UseGuidedFailure { get; set; }
+        bool Debug { get; set; }
         RetentionPeriod TentacleRetentionPeriod { get; set; }
         string EnvironmentId { get; set; }
         string TenantId { get; set; }

diff --git a/source/Octopus.Server.Client/Model/RunbookRunParameters.cs b/source/Octopus.Server.Client/Model/RunbookRunParameters.cs
@@ -30,6 +30,7 @@ public RunbookRunParameters()
         public string[] EnvironmentIds { get; set; }
         public bool ForcePackageDownload { get; set; }
         public bool? UseGuidedFailure { get; set; }
+        public bool? Debug { get; set; }
         public string[] SpecificMachineIds { get; set; }
         public string[] ExcludedMachineIds { get; set; }
         public string TenantId { get; set; }
@@ -50,6 +51,7 @@ public static RunbookRunParameters MapFrom(RunbookRunResource runbookRun)
                 EnvironmentId = runbookRun.EnvironmentId,
                 ForcePackageDownload = runbookRun.ForcePackageDownload,
                 UseGuidedFailure = runbookRun.UseGuidedFailure,
+                Debug = runbookRun.Debug,
                 SpecificMachineIds = runbookRun.SpecificMachineIds != null ? runbookRun.SpecificMachineIds.ToArray() : new string[0],
                 ExcludedMachineIds = runbookRun.ExcludedMachineIds != null ? runbookRun.ExcludedMachineIds.ToArray() : new string[0],
                 TenantId = runbookRun.TenantId,

diff --git a/source/Octopus.Server.Client/Model/RunbookRunResource.cs b/source/Octopus.Server.Client/Model/RunbookRunResource.cs
@@ -62,6 +62,12 @@ public RunbookRunResource()
         /// </summary>
         [WriteableOnCreate]
         public bool UseGuidedFailure { get; set; }
+
+        /// <summary>
+        /// When enabled contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to true
+        /// </summary>
+        [WriteableOnCreate]
+        public bool Debug { get; set; }
 
         [WriteableOnCreate]
         public string Comments { get; set; }