FilesExpand file tree

codeql-bundle-v2.27.3

/

inputs.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

80 lines (72 loc) · 2.39 KB

codeql-bundle-v2.27.3

/

inputs.ts

Copy path

Top

File metadata and controls

• Code
• Blame

80 lines (72 loc) · 2.39 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

import { ActionState } from "../action-common";

import { Feature } from "../feature-flags";

import {

RepositoryProperties,

RepositoryPropertyName,

} from "../feature-flags/properties";

/** Enumerates input names. */

export enum InputName {

Tools = "tools",

}

/** Enumerates input sources. */

export enum InputSource {

Workflow = "workflow",

RepositoryProperty = "repository-property",

}

/**

* Represents an effective input to the CodeQL Action. That is,

* the input value that was computed or selected from multiple sources.

*/

export type ComputedInput = {

/** The value of the property. */

value: string;

/** The source of the property. */

source: InputSource;

};

/**

* Gets the computed `tools` input. This comes from either the workflow or

* the repository property.

*

* @param action The Action state.

* @param repositoryProperties The values of known repository properties.

* @returns The computed input or `undefined` if there is no input.

*/

export async function getToolsInput(

action: ActionState<["Logger", "Actions", "FeatureFlags"]>,

repositoryProperties: Partial<RepositoryProperties>,

): Promise<ComputedInput | undefined> {

const name = InputName.Tools;

const input = action.actions.getOptionalInput(name);

const propertyValue = repositoryProperties[RepositoryPropertyName.TOOLS];

const allowRepositoryProperty = await action.features.getValue(

Feature.ToolsRepositoryProperty,

);

// The repository property takes precedence if it starts with an '!'.

if (allowRepositoryProperty && propertyValue?.startsWith("!")) {

action.logger.info(

`Using ${name} input from repository property (enforced): ${propertyValue}`,

);

return {

// Drop the '!' from the value.

value: propertyValue.substring(1),

source: InputSource.RepositoryProperty,

};

}

// Otherwise, the input from the workflow takes precedence.

if (input !== undefined) {

action.logger.info(`Using ${name} input from workflow: ${input}`);

return { value: input, source: InputSource.Workflow };

}

// Use the repository property if there's no workflow input.

if (allowRepositoryProperty && propertyValue !== undefined) {

action.logger.info(

`Using ${name} input from repository property: ${propertyValue}`,

);

return {

value: propertyValue,

source: InputSource.RepositoryProperty,

};

}

// There's no input.

return undefined;

}