Install npm dependencies where necessary in generated workflows

henrymercer · henrymercer · commit 879c788b4586 · 2025-08-21T16:27:50.000+01:00
diff --git a/.github/workflows/__config-input.yml b/.github/workflows/__config-input.yml
diff --git a/.github/workflows/__packaging-codescanning-config-inputs-js.yml b/.github/workflows/__packaging-codescanning-config-inputs-js.yml
diff --git a/.github/workflows/__packaging-config-inputs-js.yml b/.github/workflows/__packaging-config-inputs-js.yml
diff --git a/.github/workflows/__packaging-config-js.yml b/.github/workflows/__packaging-config-js.yml
diff --git a/.github/workflows/__packaging-inputs-js.yml b/.github/workflows/__packaging-inputs-js.yml
diff --git a/pr-checks/checks/all-platform-bundle.yml b/pr-checks/checks/all-platform-bundle.yml
@@ -3,7 +3,7 @@ description: "Tests using an all-platform CodeQL Bundle"
 versions: ["nightly-latest"]
 operatingSystems: ["ubuntu"]
 useAllPlatformBundle: "true"
-installGo: "true"
+installGo: true
 steps:
   - id: init
     uses: ./../action/init
diff --git a/pr-checks/checks/analyze-ref-input.yml b/pr-checks/checks/analyze-ref-input.yml
@@ -1,7 +1,7 @@
 name: "Analyze: 'ref' and 'sha' from inputs"
 description: "Checks that specifying 'ref' and 'sha' as inputs works"
 versions: ["default"]
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/build-mode-manual.yml b/pr-checks/checks/build-mode-manual.yml
@@ -2,7 +2,7 @@ name: "Build mode manual"
 description: "An end-to-end integration test of a Java repository built using 'build-mode: manual'"
 operatingSystems: ["ubuntu"]
 versions: ["nightly-latest"]
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     id: init
diff --git a/pr-checks/checks/config-input.yml b/pr-checks/checks/config-input.yml
@@ -1,5 +1,6 @@
 name: "Config input"
 description: "Tests specifying configuration using the config input"
+installNode: true
 operatingSystems: ["ubuntu"]
 versions: ["linked"]
 steps:
diff --git a/pr-checks/checks/export-file-baseline-information.yml b/pr-checks/checks/export-file-baseline-information.yml
@@ -1,7 +1,7 @@
 name: "Export file baseline information"
 description: "Tests that file baseline information is exported when the feature is enabled"
 versions: ["nightly-latest"]
-installGo: "true"
+installGo: true
 env:
   CODEQL_ACTION_SUBLANGUAGE_FILE_COVERAGE: true
 steps:
diff --git a/pr-checks/checks/go-custom-queries.yml b/pr-checks/checks/go-custom-queries.yml
@@ -6,7 +6,7 @@ operatingSystems:
 versions:
   - linked
   - nightly-latest
-installGo: "true"
+installGo: true
 env:
   DOTNET_GENERATE_ASPNET_CERTIFICATE: "false"
 steps:
diff --git a/pr-checks/checks/go-indirect-tracing-workaround-diagnostic.yml b/pr-checks/checks/go-indirect-tracing-workaround-diagnostic.yml
@@ -4,7 +4,7 @@ description: "Checks that we emit a diagnostic if Go is changed after the init s
 operatingSystems: ["ubuntu"]
 # pinned to a version which does not support statically linked binaries for indirect tracing
 versions: ["default"]
-installGo: "true"
+installGo: true
 collection: go
 steps:
   - uses: ./../action/init
diff --git a/pr-checks/checks/go-indirect-tracing-workaround-no-file-program.yml b/pr-checks/checks/go-indirect-tracing-workaround-no-file-program.yml
@@ -4,7 +4,7 @@ description: "Checks that we emit a diagnostic if the `file` program is not inst
 operatingSystems: ["ubuntu"]
 # pinned to a version which does not support statically linked binaries for indirect tracing
 versions: ["default"]
-installGo: "true"
+installGo: true
 collection: go
 steps:
   - name: Remove `file` program
diff --git a/pr-checks/checks/go-indirect-tracing-workaround.yml b/pr-checks/checks/go-indirect-tracing-workaround.yml
@@ -4,7 +4,7 @@ description: "Checks that our workaround for indirect tracing for Go 1.21+ on Li
 operatingSystems: ["ubuntu"]
 # pinned to a version which does not support statically linked binaries for indirect tracing
 versions: ["default"]
-installGo: "true"
+installGo: true
 collection: go
 steps:
   - uses: ./../action/init
diff --git a/pr-checks/checks/go-tracing-autobuilder.yml b/pr-checks/checks/go-tracing-autobuilder.yml
@@ -4,7 +4,7 @@ collection: go
 operatingSystems: ["ubuntu", "macos"]
 env:
   DOTNET_GENERATE_ASPNET_CERTIFICATE: "false"
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/go-tracing-custom-build-steps.yml b/pr-checks/checks/go-tracing-custom-build-steps.yml
@@ -2,7 +2,7 @@ name: "Go: tracing with custom build steps"
 description: "Checks that Go tracing traces the build when using custom build steps"
 collection: go
 operatingSystems: ["ubuntu", "macos"]
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/go-tracing-legacy-workflow.yml b/pr-checks/checks/go-tracing-legacy-workflow.yml
@@ -4,7 +4,7 @@ collection: go
 operatingSystems: ["ubuntu", "macos"]
 env:
   DOTNET_GENERATE_ASPNET_CERTIFICATE: "false"
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/multi-language-autodetect.yml b/pr-checks/checks/multi-language-autodetect.yml
@@ -1,7 +1,7 @@
 name: "Multi-language repository"
 description: "An end-to-end integration test of a multi-language repository using automatic language detection for macOS"
 operatingSystems: ["macos", "ubuntu"]
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     id: init
diff --git a/pr-checks/checks/packaging-codescanning-config-inputs-js.yml b/pr-checks/checks/packaging-codescanning-config-inputs-js.yml
@@ -1,7 +1,8 @@
 name: "Packaging: Config and input passed to the CLI"
 description: "Checks that specifying packages using a combination of a config file and input to the Action works"
 versions: ["linked", "default", "nightly-latest"] # This feature is not compatible with old CLIs
-installGo: "true"
+installGo: true
+installNode: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/packaging-config-inputs-js.yml b/pr-checks/checks/packaging-config-inputs-js.yml
@@ -1,7 +1,8 @@
 name: "Packaging: Config and input"
 description: "Checks that specifying packages using a combination of a config file and input to the Action works"
 versions: ["linked", "default", "nightly-latest"] # This feature is not compatible with old CLIs
-installGo: "true"
+installGo: true
+installNode: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/packaging-config-js.yml b/pr-checks/checks/packaging-config-js.yml
@@ -1,7 +1,8 @@
 name: "Packaging: Config file"
 description: "Checks that specifying packages using only a config file works"
 versions: ["linked", "default", "nightly-latest"] # This feature is not compatible with old CLIs
-installGo: "true"
+installGo: true
+installNode: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/packaging-inputs-js.yml b/pr-checks/checks/packaging-inputs-js.yml
@@ -1,7 +1,8 @@
 name: "Packaging: Action input"
 description: "Checks that specifying packages using the input to the Action works"
 versions: ["linked", "default", "nightly-latest"] # This feature is not compatible with old CLIs
-installGo: "true"
+installGo: true
+installNode: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/remote-config.yml b/pr-checks/checks/remote-config.yml
@@ -5,7 +5,7 @@ operatingSystems:
 versions:
   - linked
   - nightly-latest
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/split-workflow.yml b/pr-checks/checks/split-workflow.yml
@@ -2,7 +2,7 @@ name: "Split workflow"
 description: "Tests a split-up workflow in which we first build a database and later analyze it"
 operatingSystems: ["ubuntu", "macos"]
 versions: ["linked", "default", "nightly-latest"] # This feature is not compatible with old CLIs
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/swift-custom-build.yml b/pr-checks/checks/swift-custom-build.yml
@@ -2,7 +2,7 @@ name: "Swift analysis using a custom build command"
 description: "Tests creation of a Swift database using custom build"
 versions: ["linked", "default", "nightly-latest"]
 operatingSystems: ["macos"]
-installGo: "true"
+installGo: true
 env:
   DOTNET_GENERATE_ASPNET_CERTIFICATE: "false"
 steps:
diff --git a/pr-checks/checks/test-local-codeql.yml b/pr-checks/checks/test-local-codeql.yml
@@ -2,7 +2,7 @@ name: "Local CodeQL bundle"
 description: "Tests using a CodeQL bundle from a local file rather than a URL"
 versions: ["nightly-latest"]
 operatingSystems: ["ubuntu"]
-installGo: "true"
+installGo: true
 steps:
   - name: Fetch a CodeQL bundle
     shell: bash
diff --git a/pr-checks/checks/unset-environment.yml b/pr-checks/checks/unset-environment.yml
@@ -5,7 +5,7 @@ operatingSystems:
 versions:
   - linked
   - nightly-latest
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     id: init
diff --git a/pr-checks/checks/upload-quality-sarif.yml b/pr-checks/checks/upload-quality-sarif.yml
@@ -1,7 +1,7 @@
 name: "Upload-sarif: code quality endpoint"
 description: "Checks that uploading SARIFs to the code quality endpoint works"
 versions: ["default"]
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/upload-ref-sha-input.yml b/pr-checks/checks/upload-ref-sha-input.yml
@@ -1,7 +1,7 @@
 name: "Upload-sarif: 'ref' and 'sha' from inputs"
 description: "Checks that specifying 'ref' and 'sha' as inputs works"
 versions: ["default"]
-installGo: "true"
+installGo: true
 steps:
   - uses: ./../action/init
     with:
diff --git a/pr-checks/checks/with-checkout-path.yml b/pr-checks/checks/with-checkout-path.yml
@@ -1,7 +1,7 @@
 name: "Use a custom `checkout_path`"
 description: "Checks that a custom `checkout_path` will find the proper commit_oid"
 versions: ["linked"]
-installGo: "true"
+installGo: true
 steps:
   # This ensures we don't accidentally use the original checkout for any part of the test.
   - name: Delete original checkout
diff --git a/pr-checks/sync.py b/pr-checks/sync.py
@@ -44,6 +44,13 @@ def is_os_and_version_excluded(os, version, exclude_params):
 """
 
 
+def is_truthy(value):
+    if isinstance(value, str):
+        return value.lower() == 'true'
+    return bool(value)
+
+
+
 class NonAliasingRTRepresenter(ruamel.yaml.representer.RoundTripRepresenter):
     def ignore_aliases(self, data):
         return True
@@ -100,21 +107,40 @@ def writeHeader(checkStream):
             'name': 'Check out repository',
             'uses': 'actions/checkout@v5'
         },
-        {
-            'name': 'Prepare test',
-            'id': 'prepare-test',
-            'uses': './.github/actions/prepare-test',
-            'with': {
-                'version': '${{ matrix.version }}',
-                'use-all-platform-bundle': useAllPlatformBundle,
-                # If the action is being run from a container, then do not setup kotlin.
-                # This is because the kotlin binaries cannot be downloaded from the container.
-                'setup-kotlin': str(not 'container' in checkSpecification).lower(),
-            }
-        },
     ]
 
-    installGo = checkSpecification.get('installGo', '').lower() == 'true'
+    installNode = is_truthy(checkSpecification.get('installNode', ''))
+
+    if installNode:
+        steps.extend([
+            {
+                'name': 'Install Node.js',
+                'uses': 'actions/setup-node@v4',
+                'with': {
+                    'node-version': '20.x',
+                    'cache': 'npm',
+                },
+            },
+            {
+                'name': 'Install dependencies',
+                'run': 'npm install',
+            },
+        ])
+
+    steps.append({
+        'name': 'Prepare test',
+        'id': 'prepare-test',
+        'uses': './.github/actions/prepare-test',
+        'with': {
+            'version': '${{ matrix.version }}',
+            'use-all-platform-bundle': useAllPlatformBundle,
+            # If the action is being run from a container, then do not setup kotlin.
+            # This is because the kotlin binaries cannot be downloaded from the container.
+            'setup-kotlin': str(not 'container' in checkSpecification).lower(),
+        }
+    })
+
+    installGo = is_truthy(checkSpecification.get('installGo', ''))
 
     if installGo:
         baseGoVersionExpr = '>=1.21.0'
@@ -136,7 +162,7 @@ def writeHeader(checkStream):
             }
         })
 
-    installJava = checkSpecification.get('installJava', '').lower() == 'true'
+    installJava = is_truthy(checkSpecification.get('installJava', ''))
 
     if installJava:
         baseJavaVersionExpr = '17'
