From 65cfe73e1933edbc9d8be42bacc88b62ddd1a62f Mon Sep 17 00:00:00 2001
From: Ana Maria Martinez Gomez <anamg@google.com>
Date: Mon, 9 Dec 2024 12:23:58 +0100
Subject: [PATCH] [cyberchef.vm] Add documentation

Document why we can't use the `.html` directly in the shortcut, which is
also the reason why we can't use the `VM-Install-From-Zip` helper.
---
 packages/cyberchef.vm/cyberchef.vm.nuspec         | 2 +-
 packages/cyberchef.vm/tools/chocolateyinstall.ps1 | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/packages/cyberchef.vm/cyberchef.vm.nuspec b/packages/cyberchef.vm/cyberchef.vm.nuspec
index c26ac0b0..d1962fa0 100644
--- a/packages/cyberchef.vm/cyberchef.vm.nuspec
+++ b/packages/cyberchef.vm/cyberchef.vm.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
   <metadata>
     <id>cyberchef.vm</id>
-    <version>10.19.4</version>
+    <version>10.19.4.20241209</version>
     <authors>GCHQ</authors>
     <description>The Cyber Swiss Army Knife - a web app for encryption, encoding, compression, data analysis, and more.</description>
     <dependencies>
diff --git a/packages/cyberchef.vm/tools/chocolateyinstall.ps1 b/packages/cyberchef.vm/tools/chocolateyinstall.ps1
index a80275e9..bb8945a0 100644
--- a/packages/cyberchef.vm/tools/chocolateyinstall.ps1
+++ b/packages/cyberchef.vm/tools/chocolateyinstall.ps1
@@ -18,6 +18,9 @@ try {
   Install-ChocolateyZipPackage @packageArgs
   VM-Assert-Path $toolDir
 
+  # FLARE-VM adds CyberChef to the taskbar.
+  # We use the chrome executable as we can't use an `.html` shortcut for the taskbar.
+  # Because of this reason we are not using the `VM-Install-From-Zip` helper that would simplify the package code.
   $chromePath = "${env:ProgramFiles}\Google\Chrome\Application\chrome.exe"
   $cyberchefPath = Get-Item "$toolDir\CyberChef*.html"
   $iconLocation = VM-Create-Ico (Join-Path $toolDir "images\cyberchef-128x128.png")