From 713373e39e756feabf86bdde72e35709fc612139 Mon Sep 17 00:00:00 2001
From: Marius Storhaug <marstor@hotmail.com>
Date: Thu, 8 Aug 2024 19:14:30 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20workflow=20comm?=
 =?UTF-8?q?and=20`Add-Mask`=20(#114)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Description

- Added function for `Add-Mask`

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
---
 src/public/Commands/Add-Mask.ps1 | 52 ++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 src/public/Commands/Add-Mask.ps1

diff --git a/src/public/Commands/Add-Mask.ps1 b/src/public/Commands/Add-Mask.ps1
new file mode 100644
index 00000000..f953ab13
--- /dev/null
+++ b/src/public/Commands/Add-Mask.ps1
@@ -0,0 +1,52 @@
+filter Add-Mask {
+    <#
+        .SYNOPSIS
+        Mask a value in GitHub Actions
+
+        .DESCRIPTION
+        Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is
+        replaced with the * character. You can use an environment variable or string for the mask's value. When you mask a value,
+        it is treated as a secret and will be redacted on the runner. For example, after you mask a value, you won't be able to
+        set that value as an output.
+
+        .EXAMPLE
+        Add-Mask $SecretValue
+
+        Masks the value of $SecretValue so that its printed like ***.
+
+        .EXAMPLE
+        $SecretValue1, $SecretValue2 | Mask
+
+        Masks the value of $SecretValue1 and $SecretValue2 so that its printed like ***, using the pipeline
+
+        .NOTES
+        [Masking a value in a log | GitHub Docs](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#masking-a-value-in-a-log)
+    #>
+    [Alias('Mask')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidLongLines', '', Scope = 'Function',
+        Justification = 'Long documentation URL'
+    )]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function',
+        Justification = 'Does not change state'
+    )]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingWriteHost', '', Scope = 'Function',
+        Justification = 'Intended for logging in Github Runners which does support Write-Host'
+    )]
+    [CmdletBinding()]
+    param(
+        # The value to mask
+        [Parameter(
+            Mandatory,
+            ValueFromPipeline
+        )]
+        [AllowNull()]
+        [string[]] $Value
+    )
+
+    foreach ($item in $Value) {
+        Write-Host "::add-mask::$item"
+    }
+}