Fix comment in analyse Action

github · Oct 4, 2023 · 41a13ec · 41a13ec
1 parent 9a5a628
commit 41a13ec
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/lib/analyze-action.js b/lib/analyze-action.js
diff --git a/lib/analyze-action.js.map b/lib/analyze-action.js.map
diff --git a/src/analyze-action.ts b/src/analyze-action.ts
@@ -232,7 +232,10 @@ async function run() {
       logger,
     );
 
-    // Check that the Go wrapper script still exists, if set
+    // Check that `which go` still points at the wrapper script we installed in the `init` Action,
+    // if the corresponding environment variable is set. This is to ensure that there isn't a step
+    // in the workflow after the `init` step which installs a different version of Go and takes
+    // precedence in the PATH, thus potentially circumventing our workaround that allows tracing to work.
     const goWrapperPath = process.env[EnvVar.GO_BINARY_LOCATION];
 
     if (goWrapperPath !== undefined) {