Add environment variables to signal feature and version to the CLI

This PR ensures environment variables are set before any invocation of
the CLI.  Here is a list of vars that are set:

https://github.com/github/codeql-coreql-team/issues/1124#issuecomment-852463521

This ensures the CLI knows the features and versions of the containing
actions/runner.

Additionally:

- Fix the user agent so that it more closely aligns with user agent
  spec
- Refactor environment variable initialization so that it all happens in
  one place and call.
- Move Mode, getRequiredEnvParam, setMode, getMode out of actions-util
  and into util. actions-util is meant for utils only called by the
  action, not the runner.

The `prepareLocalRunEnvironment()` method is most likely deprecated and
should be removed. I originally added it because I had a way of working
where I would run the action from my local machine to test out changes,
but this was always a little flaky. So, I no longer use this way of
working. I will probably remove it soon.
This commit is contained in:
Andrew Eisenberg 2021-06-01 14:49:07 -07:00
parent 539d968ad7
commit 3708898bf2
48 changed files with 387 additions and 250 deletions

View file

@ -3,14 +3,9 @@ import * as core from "@actions/core";
import {
createStatusReportBase,
getOptionalInput,
getRequiredEnvParam,
getRequiredInput,
getTemporaryDirectory,
getToolCacheDirectory,
Mode,
prepareLocalRunEnvironment,
sendStatusReport,
setMode,
StatusReportBase,
validateWorkflow,
} from "./actions-util";
@ -26,7 +21,17 @@ import {
import { Language } from "./languages";
import { getActionsLogger } from "./logging";
import { parseRepositoryNwo } from "./repository";
import { checkGitHubVersionInRange, getGitHubVersion } from "./util";
import {
getRequiredEnvParam,
getTemporaryDirectory,
initializeEnvironment,
Mode,
checkGitHubVersionInRange,
getGitHubVersion,
} from "./util";
// eslint-disable-next-line import/no-commonjs
const pkg = require("../package.json");
interface InitSuccessStatusReport extends StatusReportBase {
// Comma-separated list of languages that analysis was run for
@ -103,7 +108,7 @@ async function sendSuccessStatusReport(
async function run() {
const startedAt = new Date();
const logger = getActionsLogger();
setMode(Mode.actions);
initializeEnvironment(Mode.actions, pkg.version);
let config: configUtils.Config;
let codeql: CodeQL;
@ -119,8 +124,6 @@ async function run() {
checkGitHubVersionInRange(gitHubVersion, logger, Mode.actions);
try {
prepareLocalRunEnvironment();
const workflowErrors = await validateWorkflow();
if (