on: Create nested list for an on: field

In r-lib/ghactions: GitHub actions for R

Description

Create nested list for an on: field

Usage

on(event, ...)

on_push(tags = NULL, branches = NULL, paths = NULL)

on_pull_request(tags = NULL, branches = NULL, paths = NULL)

on_schedule(cron = NULL)

Arguments

event	[character(1)] giving the event on which to filter. Must be one of c("push", "pull_request", "schedule").
...	[character()] giving the filters on which to run. Must correspond to the filters allowed by event.
tags, branches, paths	[character()] giving the tags, branches or modified paths on which to run the workflow. Defaults to NULL for no additional filters.
cron	[character(1)] giving UTC times using POSIX cron syntax.

Details

See the GitHub Actions workflow syntax for details.

Functions

• on_push: filter on push event

• on_pull_request: filter on pull request

• on_schedule: filter on schedule

See Also

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

Examples

on(
  event = "push",
  branches = c("master", "releases/*")
)

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