Rename getDefaultConfig and update doc comment

mbg · mbg · commit f2e20f52e0af · 2025-09-04T10:01:17.000+01:00
diff --git a/lib/init-action.js b/lib/init-action.js
diff --git a/src/config-utils.test.ts b/src/config-utils.test.ts
@@ -157,7 +157,7 @@ test("load empty config", async (t) => {
       }),
     );
 
-    const expectedConfig = await configUtils.getDefaultConfig(
+    const expectedConfig = await configUtils.initActionState(
       createTestInitConfigInputs({
         languagesInput: languages,
         tempDir,
diff --git a/src/config-utils.ts b/src/config-utils.ts
@@ -508,9 +508,10 @@ export interface InitConfigInputs {
 }
 
 /**
- * Get the default config, populated without user configuration file.
+ * Initialise the CodeQL Action state, which includes the base configuration for the Action
+ * and computes the configuration for the CodeQL CLI.
  */
-export async function getDefaultConfig(
+export async function initActionState(
   {
     analysisKindsInput,
     languagesInput,
@@ -1107,7 +1108,7 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {
     );
   }
 
-  const config = await getDefaultConfig(inputs, userConfig);
+  const config = await initActionState(inputs, userConfig);
 
   // The choice of overlay database mode depends on the selection of languages
   // and queries, which in turn depends on the user config and the augmentation

Original file line number	Diff line number	Diff line change
`@@ -508,9 +508,10 @@ export interface InitConfigInputs {`
`508`	`508`	`}`
`509`	`509`
`510`	`510`	`/**`
`511`		`- * Get the default config, populated without user configuration file.`
	`511`	`+ * Initialise the CodeQL Action state, which includes the base configuration for the Action`
	`512`	`+ * and computes the configuration for the CodeQL CLI.`
`512`	`513`	`*/`
`513`		`-export async function getDefaultConfig(`
	`514`	`+export async function initActionState(`
`514`	`515`	`{`
`515`	`516`	`analysisKindsInput,`
`516`	`517`	`languagesInput,`
`@@ -1107,7 +1108,7 @@ export async function initConfig(inputs: InitConfigInputs): Promise<Config> {`
`1107`	`1108`	`);`
`1108`	`1109`	`}`
`1109`	`1110`
`1110`		`- const config = await getDefaultConfig(inputs, userConfig);`
	`1111`	`+ const config = await initActionState(inputs, userConfig);`
`1111`	`1112`
`1112`	`1113`	`// The choice of overlay database mode depends on the selection of languages`
`1113`	`1114`	`// and queries, which in turn depends on the user config and the augmentation`