Add IsAvailable property (#11)

* Add IsAvailable property Implements #10 * Update src/Actions.Core/Summaries/Summary.cs Co-authored-by: David Pine <david.pine@microsoft.com> * Update src/Actions.Core/Summaries/Summary.cs Co-authored-by: David Pine <david.pine@microsoft.com> --------- Co-authored-by: David Pine <david.pine@microsoft.com>
IEvangelist · Apr 8, 2024 · 48aea4e · 48aea4e
1 parent 028cacd
commit 48aea4e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/Actions.Core/Summaries/Summary.cs b/src/Actions.Core/Summaries/Summary.cs
@@ -23,6 +23,11 @@ private enum Mode { Unspecified, Html, Markdown };
     /// <returns><c>true</c> if the buffer is empty</returns>
     public bool IsBufferEmpty => _buffer.Length is 0;
 
+    /// <summary>
+    /// Returns <c>true</c> if <c>GITHUB_STEP_SUMMARY</c> environment variable is set (as is the case when running in a GitHub Actions workflow).
+    /// </summary>
+    public static bool IsAvailable => GetEnvironmentVariable(GITHUB_STEP_SUMMARY) is not null;
+
     /// <summary>Finds the summary file path from the environment, rejects if env var 
     /// is not found or file does not exist. Also checks r/w permissions.</summary>
     /// <returns>The step summary file path</returns>