Create nested list for an on: field

on(event, ...)

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

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

on_schedule(cron = NULL)



[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.


[character(1)] giving UTC times using POSIX cron syntax.


See the GitHub Actions workflow syntax for details.


  • 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()


on( event = "push", branches = c("master", "releases/*") )
#> $push #> $push$branches #> [1] "master" "releases/*" #> #>