robojerk/codeql-action

Explicitly suggest wrapping in a try/catch block

Browse source
This commit is contained in:
Henry Mercer 2022-11-29 15:48:54 +00:00
parent 8f05fcd048
commit 605b23d10b
3 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/workflow.js generated
View file

@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getCategoryInputOrThrow = exports.getStepsCallingAction = exports.getWorkflowRunID = exports.getWorkflowPath = exports.getWorkflow = exports.formatWorkflowCause = exports.formatWorkflowErrors = exports.validateWorkflow = exports.getWorkflowErrors = exports.WorkflowErrors = exports.patternIsSuperset = void 0;
exports.getCategoryInputOrThrow = exports.getWorkflowRunID = exports.getWorkflowPath = exports.getWorkflow = exports.formatWorkflowCause = exports.formatWorkflowErrors = exports.validateWorkflow = exports.getWorkflowErrors = exports.WorkflowErrors = exports.patternIsSuperset = void 0;
const fs = __importStar(require("fs"));
const path = __importStar(require("path"));
const core = __importStar(require("@actions/core"));
@ -253,11 +253,12 @@ function getStepsCallingAction(job, actionName) {
}
return steps.filter((step) => { var _a; return (_a = step.uses) === null || _a === void 0 ? void 0 : _a.includes(actionName); });
}
exports.getStepsCallingAction = getStepsCallingAction;
/**
* Makes a best effort attempt to retrieve the value of a particular input with which
* an Action in the workflow would be invoked.
*
* Typically you'll want to wrap this function in a try/catch block and handle the error.
*
* @returns the value of the input, or undefined if no such input is passed to the Action
* @throws an error if the value of the input could not be determined, or we could not
* determine that no such input is passed to the Action.
@ -295,6 +296,8 @@ function getInputOrThrow(workflow, jobName, actionName, inputName, matrixVars) {
* Makes a best effort attempt to retrieve the category input for the particular job,
* given a set of matrix variables.
*
* Typically you'll want to wrap this function in a try/catch block and handle the error.
*
* @returns the category input, or undefined if the category input is not defined
* @throws an error if the category input could not be determined
*/

2
lib/workflow.js.map
View file

File diff suppressed because one or more lines are too long

6
src/workflow.ts
View file

@ -293,7 +293,7 @@ export function getWorkflowRunID(): number {
return workflowRunID;
}
export function getStepsCallingAction(
function getStepsCallingAction(
job: WorkflowJob,
actionName: string
): WorkflowJobStep[] {
@ -310,6 +310,8 @@ export function getStepsCallingAction(
* Makes a best effort attempt to retrieve the value of a particular input with which
* an Action in the workflow would be invoked.
*
* Typically you'll want to wrap this function in a try/catch block and handle the error.
*
* @returns the value of the input, or undefined if no such input is passed to the Action
* @throws an error if the value of the input could not be determined, or we could not
* determine that no such input is passed to the Action.
@ -366,6 +368,8 @@ function getInputOrThrow(
* Makes a best effort attempt to retrieve the category input for the particular job,
* given a set of matrix variables.
*
* Typically you'll want to wrap this function in a try/catch block and handle the error.
*
* @returns the category input, or undefined if the category input is not defined
* @throws an error if the category input could not be determined
*/