Expand note about defaults.json compatibility

In the future we might convert the file to JSON with comments, or add
this note to a JSON schema.
This commit is contained in:
Henry Mercer 2023-01-12 15:46:12 +00:00
parent 1eeb9df353
commit a89ad76881
12 changed files with 18 additions and 12 deletions

View file

@ -15,7 +15,7 @@ import * as api from "./api-client";
import { GitHubApiDetails } from "./api-client";
import * as codeql from "./codeql";
import { AugmentationProperties, Config } from "./config-utils";
import * as defaults from "./defaults.json"; // Referenced from codeql-action-sync-tool!
import * as defaults from "./defaults.json";
import {
CodeQLDefaultVersionInfo,
Feature,

View file

@ -3,7 +3,7 @@ import * as path from "path";
import test, { ExecutionContext } from "ava";
import * as defaults from "./defaults.json"; // Referenced from codeql-action-sync-tool!
import * as defaults from "./defaults.json";
import {
Feature,
featureConfig,

View file

@ -5,7 +5,7 @@ import * as semver from "semver";
import { getApiClient } from "./api-client";
import { CodeQL } from "./codeql";
import * as defaults from "./defaults.json"; // Referenced from codeql-action-sync-tool!
import * as defaults from "./defaults.json";
import { Logger } from "./logging";
import { RepositoryNwo } from "./repository";
import * as util from "./util";

View file

@ -9,7 +9,10 @@ import { v4 as uuidV4 } from "uuid";
import { isRunningLocalAction } from "./actions-util";
import * as api from "./api-client";
import * as defaults from "./defaults.json"; // Referenced from codeql-action-sync-tool!
// Note: defaults.json is referenced from the CodeQL Action sync tool and the Actions runner image
// creation scripts. Ensure that any changes to the format of this file are compatible with both of
// these dependents.
import * as defaults from "./defaults.json";
import { CodeQLDefaultVersionInfo } from "./feature-flags";
import { Logger } from "./logging";
import * as util from "./util";