CodeQL library for GitHub Actions
codeql/actions-all 0.4.12 (changelog, source)
Search

Module Ast

Import path

import codeql.actions.ast.internal.Ast

Predicates

explodeAccessPath
getADelimitedExpression
getAFromJsonReferenceExpression
getAJsonReferenceAccessPath
getAJsonReferenceExpression
getASimpleReferenceExpression

Holds if ${{ e }} is a GitHub Actions expression evaluated within this YAML string. See https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions. Only finds simple expressions like ${{ github.event.comment.body }}, where the expression contains only alphanumeric characters, underscores, dots, or dashes. Does not identify more complicated expressions like ${{ fromJSON(env.time) }}, or ${{ format(‘{{Hello {0}!}}’, github.event.head_commit.author.name) }}

getAToJsonReferenceExpression
lineLength

Gets the length of each line in the StringValue .

numberOfLines
partialLineLengthSum

Gets the sum of the length of the lines up to the given index.

Classes

AstNodeImpl
CompositeActionImpl
DefaultsImpl
EnvExpressionImpl

Holds for an expression accesing the env context. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability e.g. ${{ env.foo }}

EnvImpl
EnvironmentImpl
EventImpl
ExpressionImpl
ExternalJobImpl
GitHubExpressionImpl

Holds for an expression accesing the github context. e.g. ${{ github.head_ref }}

IfImpl
InputImpl
InputsExpressionImpl

Holds for an expression the inputs context. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability e.g. ${{ inputs.foo }}

InputsImpl
JobImpl
JobsExpressionImpl

Holds for an expression accesing the jobs context. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability e.g. ${{ jobs.job1.outputs.foo}} (within reusable workflows)

JsonReferenceExpressionImpl
LocalJobImpl
MatrixAccessPathImpl
MatrixExpressionImpl

Holds for an expression accesing the matrix context. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability e.g. ${{ matrix.foo }}

NeedsExpressionImpl

Holds for an expression accesing the needs context. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability e.g. ${{ needs.job1.outputs.foo}}

NeedsImpl
OnImpl
OutputsImpl
PermissionsImpl
ReusableWorkflowImpl
RunImpl
RunsImpl
ScalarValueImpl
SecretsExpressionImpl

Holds for an expression accesing the secrets context. e.g. ${{ secrets.FOO }}

ShellScriptImpl
SimpleReferenceExpressionImpl

A ${{}} expression accessing a sigcle context variable such as steps, needs, jobs, env, inputs, or matrix. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability

StepImpl
StepsContainerImpl
StepsExpressionImpl

Holds for an expression accesing the steps context. https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability e.g. ${{ steps.changed-files.outputs.all_changed_files }}

StrategyImpl
UsesImpl
UsesStepImpl

A Uses step represents a call to an action that is defined in a GitHub repository.

WorkflowImpl