Merge pull request #1684 from github/mbg/add-resolve-environment

github · Jun 15, 2023 · 0ac1815 · 0ac1815
2 parents ee2b24e + d4006d9
commit 0ac1815
Show file tree

Hide file tree

Showing 15 changed files with 453 additions and 5 deletions.
diff --git a/.github/workflows/__resolve-environment-action.yml b/.github/workflows/__resolve-environment-action.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## [UNRELEASED]
 
-No user facing changes.
+- Experimental: add a new `resolve-environment` action which attempts to infer a configuration for the build environment that is required to build a given project. Do not use this in production as it is part of an internal experiment and subject to change at any time.
 
 ## 2.20.0 - 13 Jun 2023
 

diff --git a/lib/actions-util.js.map b/lib/actions-util.js.map
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/lib/resolve-environment-action.js b/lib/resolve-environment-action.js
diff --git a/lib/resolve-environment-action.js.map b/lib/resolve-environment-action.js.map
diff --git a/lib/resolve-environment.js b/lib/resolve-environment.js
diff --git a/lib/resolve-environment.js.map b/lib/resolve-environment.js.map
diff --git a/pr-checks/checks/resolve-environment-action.yml b/pr-checks/checks/resolve-environment-action.yml
@@ -0,0 +1,17 @@
+name: "Resolve environment"
+description: "Tests that the resolve-environment action works for Go"
+versions: ["stable-v2.13.4"]
+steps:
+  - uses: ./../action/init
+    with:
+      languages: go
+      tools: ${{ steps.prepare-test.outputs.tools-url }}
+
+  - uses: ./../action/resolve-environment
+    id: resolve-environment
+    with:
+      language: go
+
+  - name: "Fail if no Go configuration was returned"
+    if: (!fromJSON(steps.resolve-environment.outputs.environment).configuration.go)
+    run: exit 1
diff --git a/resolve-environment/action.yml b/resolve-environment/action.yml
@@ -0,0 +1,23 @@
+name: 'CodeQL: Resolve Build Environment'
+description: '[Experimental] Attempt to infer a build environment suitable for automatic builds'
+author: 'GitHub'
+inputs:
+  token:
+    default: ${{ github.token }}
+  matrix:
+    default: ${{ toJson(matrix) }}
+  language:
+    description: The language to infer the build environment configuration for.
+    required: true
+  working-directory:
+    description: >-
+      Resolve the build environment based on the files located at the specified
+      path (relative to $GITHUB_WORKSPACE). If this input is not set, then the
+      build environment is resolved based on the files in $GITHUB_WORKSPACE.
+    required: false
+outputs:
+  environment:
+    description: The inferred build environment configuration.
+runs:
+  using: 'node16'
+  main: '../lib/resolve-environment-action.js'
diff --git a/src/actions-util.ts b/src/actions-util.ts
@@ -306,7 +306,8 @@ type ActionName =
   | "autobuild"
   | "finish"
   | "upload-sarif"
-  | "init-post";
+  | "init-post"
+  | "resolve-environment";
 export type ActionStatus =
   | "starting"
   | "aborted"