index.md

job

Subpackages

• step

Index

• fn withConcurrency(value)
• fn withConcurrencyMixin(value)
• fn withContainer(value)
• fn withContainerMixin(value)
• fn withContinueOnError(value)
• fn withContinueOnErrorMixin(value)
• fn withDefaults(value)
• fn withDefaultsMixin(value)
• fn withEnv(value)
• fn withEnvMixin(value)
• fn withEnvironment(value)
• fn withEnvironmentMixin(value)
• fn withIf(value)
• fn withName(value)
• fn withNeeds(value)
• fn withNeedsMixin(value)
• fn withOutputs(value)
• fn withOutputsMixin(value)
• fn withPermissions(value)
• fn withPermissionsMixin(value)
• fn withRunsOn(value)
• fn withRunsOnMixin(value)
• fn withServices(value)
• fn withServicesMixin(value)
• fn withSteps(value)
• fn withStepsMixin(value)
• fn withStrategy(value)
• fn withStrategyMixin(value)
• fn withTimeoutMinutes(value=360)
• fn withTimeoutMinutesMixin(value=360)
• obj concurrency
  • fn withCancelInProgress(value)
  • fn withCancelInProgressMixin(value)
  • fn withGroup(value)
  • obj cancel-in-progress
    • fn withExpressionSyntax(value)
• obj container
  • fn withContainer(value)
  • fn withContainerMixin(value)
  • fn withCredentials(value)
  • fn withCredentialsMixin(value)
  • fn withEnv(value)
  • fn withEnvMixin(value)
  • fn withImage(value)
  • fn withOptions(value)
  • fn withPorts(value)
  • fn withPortsMixin(value)
  • fn withVolumes(value)
  • fn withVolumesMixin(value)
  • obj container
    • fn withCredentials(value)
    • fn withCredentialsMixin(value)
    • fn withEnv(value)
    • fn withEnvMixin(value)
    • fn withImage(value)
    • fn withOptions(value)
    • fn withPorts(value)
    • fn withPortsMixin(value)
    • fn withVolumes(value)
    • fn withVolumesMixin(value)
    • obj credentials
      • fn withPassword(value)
      • fn withUsername(value)
    • obj env
      • fn withStringContainingExpressionSyntax(value)
  • obj credentials
    • fn withPassword(value)
    • fn withUsername(value)
  • obj env
    • fn withStringContainingExpressionSyntax(value)
• obj continue-on-error
  • fn withExpressionSyntax(value)
• obj defaults
  • fn withRun(value)
  • fn withRunMixin(value)
  • obj run
    • fn withShell(value)
    • fn withShellMixin(value)
    • fn withWorkingDirectory(value)
• obj env
  • fn withStringContainingExpressionSyntax(value)
• obj environment
  • fn withEnvironment(value)
  • fn withEnvironmentMixin(value)
  • obj environment
    • fn withName(value)
    • fn withUrl(value)
• obj needs
  • fn withName(value)
• obj permissions
  • fn withActions(value)
  • fn withAttestations(value)
  • fn withChecks(value)
  • fn withContents(value)
  • fn withDeployments(value)
  • fn withDiscussions(value)
  • fn withIdToken(value)
  • fn withIssues(value)
  • fn withPackages(value)
  • fn withPages(value)
  • fn withPullRequests(value)
  • fn withRepositoryProjects(value)
  • fn withSecurityEvents(value)
  • fn withStatuses(value)
• obj runs-on
  • fn withExpressionSyntax(value)
  • fn withGroup(value)
  • fn withLabels(value)
  • fn withLabelsMixin(value)
  • fn withStringContainingExpressionSyntax(value)
• obj strategy
  • fn withFailFast(value=true)
  • fn withMatrix(value)
  • fn withMatrixMixin(value)
  • fn withMaxParallel(value)
  • obj matrix
    • fn withExpressionSyntax(value)
• obj timeout-minutes
  • fn withExpressionSyntax(value)

Fields

fn withConcurrency

withConcurrency(value)

PARAMETERS:

• value (object,string)

Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level. When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.

fn withConcurrencyMixin

withConcurrencyMixin(value)

PARAMETERS:

• value (object,string)

Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level. When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.

fn withContainer

withContainer(value)

PARAMETERS:

• value (object)

A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts. If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.

fn withContainerMixin

withContainerMixin(value)

PARAMETERS:

• value (object)

A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts. If you do not set a container, all steps will run directly on the host specified by runs-on unless a step refers to an action configured to run in a container.

fn withContinueOnError

withContinueOnError(value)

PARAMETERS:

• value (boolean,string)

Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.

fn withContinueOnErrorMixin

withContinueOnErrorMixin(value)

PARAMETERS:

• value (boolean,string)

Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.

fn withDefaults

withDefaults(value)

PARAMETERS:

• value (object)

A map of default settings that will apply to all steps in the job.

fn withDefaultsMixin

withDefaultsMixin(value)

PARAMETERS:

• value (object)

A map of default settings that will apply to all steps in the job.

fn withEnv

withEnv(value)

PARAMETERS:

• value (object,string)

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

fn withEnvMixin

withEnvMixin(value)

PARAMETERS:

• value (object,string)

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

fn withEnvironment

withEnvironment(value)

PARAMETERS:

• value (object,string)

The environment that the job references.

fn withEnvironmentMixin

withEnvironmentMixin(value)

PARAMETERS:

• value (object,string)

The environment that the job references.

fn withIf

withIf(value)

PARAMETERS:

• value (boolean,number,string)

You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

fn withName

withName(value)

PARAMETERS:

• value (string)

The name of the job displayed on GitHub.

fn withNeeds

withNeeds(value)

PARAMETERS:

• value (array,string)

Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.

fn withNeedsMixin

withNeedsMixin(value)

PARAMETERS:

• value (array,string)

Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional statement that causes the job to continue.

fn withOutputs

withOutputs(value)

PARAMETERS:

• value (object)

A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.

fn withOutputsMixin

withOutputsMixin(value)

PARAMETERS:

• value (object)

A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.

fn withPermissions

withPermissions(value)

PARAMETERS:

• value (object,string)

You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.

fn withPermissionsMixin

withPermissionsMixin(value)

PARAMETERS:

• value (object,string)

You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.

fn withRunsOn

withRunsOn(value)

PARAMETERS:

• value (array,object,string)

The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.

fn withRunsOnMixin

withRunsOnMixin(value)

PARAMETERS:

• value (array,object,string)

The type of machine to run the job on. The machine can be either a GitHub-hosted runner, or a self-hosted runner.

fn withServices

withServices(value)

PARAMETERS:

• value (object)

Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers. When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network. When both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name. When a step does not use a container action, you must access the service using localhost and bind the ports.

fn withServicesMixin

withServicesMixin(value)

PARAMETERS:

• value (object)

Additional containers to host services for a job in a workflow. These are useful for creating databases or cache services like redis. The runner on the virtual machine will automatically create a network and manage the life cycle of the service containers. When you use a service container for a job or your step uses container actions, you don't need to set port information to access the service. Docker automatically exposes all ports between containers on the same network. When both the job and the action run in a container, you can directly reference the container by its hostname. The hostname is automatically mapped to the service name. When a step does not use a container action, you must access the service using localhost and bind the ports.

fn withSteps

withSteps(value)

PARAMETERS:

• value (array)

A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job. Must contain either uses or run

fn withStepsMixin

withStepsMixin(value)

PARAMETERS:

• value (array)

A job contains a sequence of tasks called steps. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the virtual environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job. Must contain either uses or run

fn withStrategy

withStrategy(value)

PARAMETERS:

• value (object)

A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.

fn withStrategyMixin

withStrategyMixin(value)

PARAMETERS:

• value (object)

A strategy creates a build matrix for your jobs. You can define different variations of an environment to run each job in.

fn withTimeoutMinutes

withTimeoutMinutes(value=360)

PARAMETERS:

• value (number,string)
  • default value: 360

The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360

fn withTimeoutMinutesMixin

withTimeoutMinutesMixin(value=360)

PARAMETERS:

• value (number,string)
  • default value: 360

The maximum number of minutes to let a workflow run before GitHub automatically cancels it. Default: 360

obj concurrency

fn concurrency.withCancelInProgress

concurrency.withCancelInProgress(value)

PARAMETERS:

• value (boolean,string)

To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.

fn concurrency.withCancelInProgressMixin

concurrency.withCancelInProgressMixin(value)

PARAMETERS:

• value (boolean,string)

To cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.

fn concurrency.withGroup

concurrency.withGroup(value)

PARAMETERS:

• value (string)

When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. Any previously pending job or workflow in the concurrency group will be canceled.

obj concurrency.cancel-in-progress

fn concurrency.cancel-in-progress.withExpressionSyntax

concurrency.cancel-in-progress.withExpressionSyntax(value)

PARAMETERS:

• value (string)

obj container

fn container.withContainer

container.withContainer(value)

PARAMETERS:

• value (object)

fn container.withContainerMixin

container.withContainerMixin(value)

PARAMETERS:

• value (object)

fn container.withCredentials

container.withCredentials(value)

PARAMETERS:

• value (object)

If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the docker login command.

fn container.withCredentialsMixin

container.withCredentialsMixin(value)

PARAMETERS:

• value (object)

If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the docker login command.

fn container.withEnv

container.withEnv(value)

PARAMETERS:

• value (object,string)

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

fn container.withEnvMixin

container.withEnvMixin(value)

PARAMETERS:

• value (object,string)

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

fn container.withImage

container.withImage(value)

PARAMETERS:

• value (string)

The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.

fn container.withOptions

container.withOptions(value)

PARAMETERS:

• value (string)

Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.

fn container.withPorts

container.withPorts(value)

PARAMETERS:

• value (array)

Sets an array of ports to expose on the container.

fn container.withPortsMixin

container.withPortsMixin(value)

PARAMETERS:

• value (array)

Sets an array of ports to expose on the container.

fn container.withVolumes

container.withVolumes(value)

PARAMETERS:

• value (array)

Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. To specify a volume, you specify the source and destination path: : The is a volume name or an absolute path on the host machine, and is an absolute path in the container.

fn container.withVolumesMixin

container.withVolumesMixin(value)

PARAMETERS:

• value (array)

Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. To specify a volume, you specify the source and destination path: : The is a volume name or an absolute path on the host machine, and is an absolute path in the container.

obj container.container

fn container.container.withCredentials

container.container.withCredentials(value)

PARAMETERS:

• value (object)

If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the docker login command.

fn container.container.withCredentialsMixin

container.container.withCredentialsMixin(value)

PARAMETERS:

• value (object)

If the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. The credentials are the same values that you would provide to the docker login command.

fn container.container.withEnv

container.container.withEnv(value)

PARAMETERS:

• value (object,string)

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

fn container.container.withEnvMixin

container.container.withEnvMixin(value)

PARAMETERS:

• value (object,string)

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env keywords. For more information, see https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsenv

fn container.container.withImage

container.container.withImage(value)

PARAMETERS:

• value (string)

The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a registry name.

fn container.container.withOptions

container.container.withOptions(value)

PARAMETERS:

• value (string)

Additional Docker container resource options. For a list of options, see https://docs.docker.com/engine/reference/commandline/create/#options.

fn container.container.withPorts

container.container.withPorts(value)

PARAMETERS:

• value (array)

Sets an array of ports to expose on the container.

fn container.container.withPortsMixin

container.container.withPortsMixin(value)

PARAMETERS:

• value (array)

Sets an array of ports to expose on the container.

fn container.container.withVolumes

container.container.withVolumes(value)

PARAMETERS:

• value (array)

Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. To specify a volume, you specify the source and destination path: : The is a volume name or an absolute path on the host machine, and is an absolute path in the container.

fn container.container.withVolumesMixin

container.container.withVolumesMixin(value)

PARAMETERS:

• value (array)

Sets an array of volumes for the container to use. You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host. To specify a volume, you specify the source and destination path: : The is a volume name or an absolute path on the host machine, and is an absolute path in the container.

obj container.container.credentials

fn container.container.credentials.withPassword

container.container.credentials.withPassword(value)

PARAMETERS:

• value (string)

fn container.container.credentials.withUsername

container.container.credentials.withUsername(value)

PARAMETERS:

• value (string)

obj container.container.env

fn container.container.env.withStringContainingExpressionSyntax

container.container.env.withStringContainingExpressionSyntax(value)

PARAMETERS:

• value (string)

obj container.credentials

fn container.credentials.withPassword

container.credentials.withPassword(value)

PARAMETERS:

• value (string)

fn container.credentials.withUsername

container.credentials.withUsername(value)

PARAMETERS:

• value (string)

obj container.env

fn container.env.withStringContainingExpressionSyntax

container.env.withStringContainingExpressionSyntax(value)

PARAMETERS:

• value (string)

obj continue-on-error

fn continue-on-error.withExpressionSyntax

continue-on-error.withExpressionSyntax(value)

PARAMETERS:

• value (string)

obj defaults

fn defaults.withRun

defaults.withRun(value)

PARAMETERS:

• value (object)

fn defaults.withRunMixin

defaults.withRunMixin(value)

PARAMETERS:

• value (object)

obj defaults.run

fn defaults.run.withShell

defaults.run.withShell(value)

PARAMETERS:

• value (string)

You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.

fn defaults.run.withShellMixin

defaults.run.withShellMixin(value)

PARAMETERS:

• value (string)

You can override the default shell settings in the runner's operating system using the shell keyword. You can use built-in shell keywords, or you can define a custom set of shell options.

fn defaults.run.withWorkingDirectory

defaults.run.withWorkingDirectory(value)

PARAMETERS:

• value (string)

Using the working-directory keyword, you can specify the working directory of where to run the command.

obj env

fn env.withStringContainingExpressionSyntax

env.withStringContainingExpressionSyntax(value)

PARAMETERS:

• value (string)

obj environment

fn environment.withEnvironment

environment.withEnvironment(value)

PARAMETERS:

• value (object)

The environment that the job references

fn environment.withEnvironmentMixin

environment.withEnvironmentMixin(value)

PARAMETERS:

• value (object)

The environment that the job references

obj environment.environment

fn environment.environment.withName

environment.environment.withName(value)

PARAMETERS:

• value (string)

The name of the environment configured in the repo.

fn environment.environment.withUrl

environment.environment.withUrl(value)

PARAMETERS:

• value (string)

A deployment URL

obj needs

fn needs.withName

needs.withName(value)

PARAMETERS:

• value (string)

obj permissions

fn permissions.withActions

permissions.withActions(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withAttestations

permissions.withAttestations(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withChecks

permissions.withChecks(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withContents

permissions.withContents(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withDeployments

permissions.withDeployments(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withDiscussions

permissions.withDiscussions(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withIdToken

permissions.withIdToken(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withIssues

permissions.withIssues(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withPackages

permissions.withPackages(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withPages

permissions.withPages(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withPullRequests

permissions.withPullRequests(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withRepositoryProjects

permissions.withRepositoryProjects(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withSecurityEvents

permissions.withSecurityEvents(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

fn permissions.withStatuses

permissions.withStatuses(value)

PARAMETERS:

• value (string)
  • valid values: "read", "write", "none"

obj runs-on

fn runs-on.withExpressionSyntax

runs-on.withExpressionSyntax(value)

PARAMETERS:

• value (string)

fn runs-on.withGroup

runs-on.withGroup(value)

PARAMETERS:

• value (string)

fn runs-on.withLabels

runs-on.withLabels(value)

PARAMETERS:

• value (array,string)

fn runs-on.withLabelsMixin

runs-on.withLabelsMixin(value)

PARAMETERS:

• value (array,string)

fn runs-on.withStringContainingExpressionSyntax

runs-on.withStringContainingExpressionSyntax(value)

PARAMETERS:

• value (string)

obj strategy

fn strategy.withFailFast

strategy.withFailFast(value=true)

PARAMETERS:

• value (boolean,string)
  • default value: true

When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true

fn strategy.withMatrix

strategy.withMatrix(value)

PARAMETERS:

• value (object,string)

A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status. You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix. When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

fn strategy.withMatrixMixin

strategy.withMatrixMixin(value)

PARAMETERS:

• value (object,string)

A build matrix is a set of different configurations of the virtual environment. For example you might run a job against more than one supported version of a language, operating system, or tool. Each configuration is a copy of the job that runs and reports a status. You can specify a matrix by supplying an array for the configuration options. For example, if the GitHub virtual environment supports Node.js versions 6, 8, and 10 you could specify an array of those versions in the matrix. When you define a matrix of operating systems, you must set the required runs-on keyword to the operating system of the current job, rather than hard-coding the operating system name. To access the operating system name, you can use the matrix.os context parameter to set runs-on. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.

fn strategy.withMaxParallel

strategy.withMaxParallel(value)

PARAMETERS:

• value (number,string)

The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.

obj strategy.matrix

fn strategy.matrix.withExpressionSyntax

strategy.matrix.withExpressionSyntax(value)

PARAMETERS:

• value (string)

obj timeout-minutes

fn timeout-minutes.withExpressionSyntax

timeout-minutes.withExpressionSyntax(value)

PARAMETERS:

• value (string)