job: Create nested list for _one_ job

Description Usage Arguments See Also

View source: R/syntax.R

Description

Create nested list for one job

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
job(
  id,
  name = NULL,
  needs = NULL,
  `runs-on` = "ubuntu-18.04",
  steps = NULL,
  timeout_minutes = NULL,
  strategy = NULL,
  container = NULL,
  services = NULL
)

Arguments

id, name

[character(1)] giving additional options for the job. Defaults to NULL.

needs

[character()] giving the jobs that must complete successfully before this job is run. Defaults to NULL for no dependencies.

runs-on

[character(1)] giving the type of virtual host machine to run the job on. Defaults to "ubuntu-18.04". Must be one of ghactions_vms.

steps

[list()] giving an unnamed list of steps, with each element as returned by step(). Defaults to NULL.

timeout_minutes

[integer(1)] giving the maximum number of minutes to let a workflow run before GitHub automatically cancels it. Defaults to NULL.

strategy

[list()] giving a named list as returned by strategy(). Defaults to NULL.

container

[character(1)]/[list()] giving a published container image. For advanced options, use container(). Defaults to NULL.

services

[list()] giving additional containers to host services for a job in a workflow in a named list. Use container() to construct the list elements. Defaults to NULL.

See Also

Other syntax: container(), gh_matrix(), ghactions_events, ghactions_vms, on(), step(), strategy(), workflow()


r-lib/ghactions documentation built on Dec. 15, 2020, 4:07 p.m.