(cake-build#4019) Add build status update messages

BlythMeister · Oct 25, 2022 · 1a23887 · 1a23887
1 parent 03107f6
commit 1a23887
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 1 deletion.
diff --git a/src/Cake.Common/Build/TeamCity/ITeamCityProvider.cs b/src/Cake.Common/Build/TeamCity/ITeamCityProvider.cs
@@ -153,13 +153,34 @@ public interface ITeamCityProvider
         void WriteStartProgress(string message);
 
         /// <summary>
-        /// Write a status message to the TeamCity build log.
+        /// Write a message to the TeamCity build log. - Messages not added to the build status.
         /// </summary>
         /// <param name="message">Message contents.</param>
         /// <param name="status">Build status.</param>
         /// <param name="errorDetails">Error details if status is error.</param>
         void WriteStatus(string message, string status = "NORMAL", string errorDetails = null);
 
+        /// <summary>
+        /// Write a status message to the TeamCity build log. - Prepend message to build status.
+        /// </summary>
+        /// <param name="message">Message contents.</param>
+        /// <param name="status">Build status.</param>
+        void WritePrependBuildStatus(string message, string status = null);
+
+        /// <summary>
+        /// Write a status message to the TeamCity build log. - append message to build status.
+        /// </summary>
+        /// <param name="message">Message contents.</param>
+        /// <param name="status">Build status.</param>
+        void WriteAppendBuildStatus(string message, string status = null);
+
+        /// <summary>
+        /// Write a status message to the TeamCity build log. - replace existing build status.
+        /// </summary>
+        /// <param name="message">Message contents.</param>
+        /// <param name="status">Build status.</param>
+        void WriteReplacementBuildStatus(string message, string status = null);
+
         /// <summary>
         /// Write a statistic message to the TeamCity build log.
         /// </summary>

diff --git a/src/Cake.Common/Build/TeamCity/TeamCityProvider.cs b/src/Cake.Common/Build/TeamCity/TeamCityProvider.cs
@@ -120,6 +120,54 @@ public void WriteStatus(string message, string status = "NORMAL", string errorDe
             WriteServiceMessage("message", attrs);
         }
 
+        /// <inheritdoc/>
+        public void WriteAppendBuildStatus(string message, string status = null)
+        {
+            var attrs = new Dictionary<string, string>
+            {
+                { "text", $"{{build.status.text}}; {message}" }
+            };
+
+            if (status != null)
+            {
+                attrs.Add("status", status);
+            }
+
+            WriteServiceMessage("buildStatus", attrs);
+        }
+
+        /// <inheritdoc/>
+        public void WritePrependBuildStatus(string message, string status = null)
+        {
+            var attrs = new Dictionary<string, string>
+            {
+                { "text", $"{message}; {{build.status.text}}" }
+            };
+
+            if (status != null)
+            {
+                attrs.Add("status", status);
+            }
+
+            WriteServiceMessage("buildStatus", attrs);
+        }
+
+        /// <inheritdoc/>
+        public void WriteReplacementBuildStatus(string message, string status = null)
+        {
+            var attrs = new Dictionary<string, string>
+            {
+                { "text", message }
+            };
+
+            if (status != null)
+            {
+                attrs.Add("status", status);
+            }
+
+            WriteServiceMessage("buildStatus", attrs);
+        }
+
         /// <inheritdoc/>
         public void ImportData(string type, FilePath path)
         {