Add and use `getDisplayActionName` for log message · github/codeql-action@5fa9c0c · GitHub

github / codeql-action Public

• Notifications You must be signed in to change notification settings
• Fork 487
• Star 1.6k

• Code
• Issues 158
• Pull requests 35
• Actions
• Security and quality 2
• Insights

Additional navigation options

Commit 5fa9c0c

Browse filesBrowse the repository at this point in the historyBrowse files

mbg

committed

Add and use getDisplayActionName for log message

1 parent eba9d55 commit 5fa9c0c
Copy full SHA for 5fa9c0c

3 files changed

+28-3Lines changed: 28 additions & 3 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• lib
  • entry-points.js
• src
  • action-common.ts
  • status-report.ts

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎lib/entry-points.js‎

Copy file name to clipboardExpand all lines: lib/entry-points.js

+9-1Lines changed: 9 additions & 1 deletion

Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Collapse file

‎src/action-common.ts‎

Copy file name to clipboardExpand all lines: src/action-common.ts

+8-2Lines changed: 8 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -4,7 +4,11 @@ import { ActionsEnv, getActionsEnv } from "./actions-util";
4	4	import { Env } from "./environment";
5	5	import { FeatureEnablement } from "./feature-flags";
6	6	import { getActionsLogger, Logger } from "./logging";
7		- import { ActionName, sendUnhandledErrorStatusReport } from "./status-report";
	7	+ import {
	8	+ ActionName,
	9	+ getDisplayActionName,
	10	+ sendUnhandledErrorStatusReport,
	11	+ } from "./status-report";
8	12	import { getEnv, getErrorMessage } from "./util";
9	13
10	14	/** Common state that is always available in `ActionState`. */
@@ -83,7 +87,9 @@ export async function runInActions(action: Action) {
83	87	actions: actionsEnv,
84	88	});
85	89	} catch (error) {
86		- core.setFailed(`${action.name} action failed: ${getErrorMessage(error)}`);
	90	+ core.setFailed(
	91	+ `${getDisplayActionName(action.name)} action failed: ${getErrorMessage(error)}`,
	92	+ );
87	93	await sendUnhandledErrorStatusReport(action.name, startedAt, error, logger);
88	94	}
89	95	}

Collapse file

‎src/status-report.ts‎

Copy file name to clipboardExpand all lines: src/status-report.ts

+11Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -46,6 +46,17 @@ export enum ActionName {
46	46	UploadSarif = "upload-sarif",
47	47	}
48	48
	49	+ /**
	50	+ * Maps an `ActionName` to its display name. Usually that is the same, except
	51	+ * for `ActionName.Analyze` where it is `"analyze"` instead of `"finish"`.
	52	+ */
	53	+ export function getDisplayActionName(actionName: ActionName): string {
	54	+ if (actionName === ActionName.Analyze) {
	55	+ return "analyze";
	56	+ }
	57	+ return actionName;
	58	+ }
	59	+
49	60	/**
50	61	* @returns a boolean indicating whether the analysis is considered to be first party.
51	62	*

0 commit comments

Comments

0 (0)