Add helpers to log a GitHub "notice"

Azure · Nov 15, 2024 · fc3f04d · fc3f04d
1 parent 15d3f80
commit fc3f04d
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/eng/common/scripts/logging.ps1 b/eng/common/scripts/logging.ps1
@@ -10,6 +10,26 @@ function LogInfo {
   Write-Host "$args"
 }
 
+function LogNotice {
+  if (Test-SupportsGitHubLogging) {
+    Write-Host ("::notice::$args" -replace "`n", "%0D%0A")
+  }
+  else {
+    # No equivalent for DevOps
+    Write-Host "[Notice] $args"
+  }
+}
+
+function LogNoticeForFile($file, $noticeString) {
+  if (Test-SupportsGitHubLogging) {
+    Write-Host ("::notice file=$file,line=1,col=1::$noticeString" -replace "`n", "%0D%0A")
+  }
+  else {
+    # No equivalent for DevOps
+    Write-Host "[Notice in file $file] $noticeString"
+  }
+}
+
 function LogWarning {
   if (Test-SupportsDevOpsLogging) {
     Write-Host ("##vso[task.LogIssue type=warning;]$args" -replace "`n", "%0D%0A")