Improve variable names and comments

Also set default `GITHUB_EVENT_NAME` in `setupActionsVars`

Author: mbg

lib/analyze-action.js

@@ -334,8 +334,6 @@ test("getCodeQLSource correctly returns nightly CLI version when forced by FF",
   const logger = getRecordingLogger(loggedMessages);
   const features = createFeatures([Feature.ForceNightly]);
 
-  process.env["GITHUB_EVENT_NAME"] = "dynamic";
-
   const expectedDate = "30260213";
   const expectedTag = `codeql-bundle-${expectedDate}`;
 
@@ -356,6 +354,8 @@ test("getCodeQLSource correctly returns nightly CLI version when forced by FF",
 
   await withTmpDir(async (tmpDir) => {
     setupActionsVars(tmpDir, tmpDir);
+    process.env["GITHUB_EVENT_NAME"] = "dynamic";
+
     const source = await setupCodeql.getCodeQLSource(
       undefined,
       SAMPLE_DEFAULT_CLI_VERSION,
@@ -393,8 +393,6 @@ test("getCodeQLSource correctly returns latest version from toolcache when tools
   const logger = getRecordingLogger(loggedMessages);
   const features = createFeatures([Feature.AllowToolcacheInput]);
 
-  process.env["GITHUB_EVENT_NAME"] = "dynamic";
-
   const latestToolcacheVersion = "3.2.1";
   const latestVersionPath = "/path/to/latest";
   const testVersions = ["2.3.1", latestToolcacheVersion, "1.2.3"];
@@ -408,6 +406,8 @@ test("getCodeQLSource correctly returns latest version from toolcache when tools
 
   await withTmpDir(async (tmpDir) => {
     setupActionsVars(tmpDir, tmpDir);
+    process.env["GITHUB_EVENT_NAME"] = "dynamic";
+
     const source = await setupCodeql.getCodeQLSource(
       "toolcache",
       SAMPLE_DEFAULT_CLI_VERSION,
@@ -463,16 +463,17 @@ const toolcacheInputFallbackMacro = test.macro({
     const logger = getRecordingLogger(loggedMessages);
     const features = createFeatures(featureList);
 
-    for (const [k, v] of Object.entries(environment)) {
-      process.env[k] = v;
-    }
-
     const findAllVersionsStub = sinon
       .stub(toolcache, "findAllVersions")
       .returns(testVersions);
 
     await withTmpDir(async (tmpDir) => {
       setupActionsVars(tmpDir, tmpDir);
+
+      for (const [k, v] of Object.entries(environment)) {
+        process.env[k] = v;
+      }
+
       const source = await setupCodeql.getCodeQLSource(
         "toolcache",
         SAMPLE_DEFAULT_CLI_VERSION,

lib/init-action-post.js

@@ -321,17 +321,19 @@ export async function getCodeQLSource(
    */
   let url: string | undefined;
 
-  // We only allow forcing the nightly CLI via the FF for `dynamic` events (or in test mode).
-  // For advanced workflows, a value from `CODEQL_NIGHTLY_TOOLS_INPUTS` can be specified.
+  // We allow forcing the nightly CLI via the FF for `dynamic` events (or in test mode) where the
+  // `tools` input cannot be adjusted to explicitly request it.
+  const canForceNightlyWithFF = isDynamicWorkflow() || util.isInTestMode();
   const forceNightlyValueFF = await features.getValue(Feature.ForceNightly);
-  const forceNightly =
-    forceNightlyValueFF && (isDynamicWorkflow() || util.isInTestMode());
+  const forceNightly = forceNightlyValueFF && canForceNightlyWithFF;
 
-  if (
-    forceNightly ||
-    (toolsInput !== undefined &&
-      CODEQL_NIGHTLY_TOOLS_INPUTS.includes(toolsInput))
-  ) {
+  // For advanced workflows, a value from `CODEQL_NIGHTLY_TOOLS_INPUTS` can be specified explicitly
+  // for the `tools` input in the workflow file.
+  const nightlyRequestedByToolsInput =
+    toolsInput !== undefined &&
+    CODEQL_NIGHTLY_TOOLS_INPUTS.includes(toolsInput);
+
+  if (forceNightly || nightlyRequestedByToolsInput) {
     if (forceNightly) {
       logger.info(
         `Using the latest CodeQL CLI nightly, as forced by the ${Feature.ForceNightly} feature flag.`,

lib/init-action.js

@@ -145,6 +145,7 @@ export function setupActionsVars(tempDir: string, toolsDir: string) {
   process.env["RUNNER_TEMP"] = tempDir;
   process.env["RUNNER_TOOL_CACHE"] = toolsDir;
   process.env["GITHUB_WORKSPACE"] = tempDir;
+  process.env["GITHUB_EVENT_NAME"] = "push";
 }
 
 export interface LoggedMessage {