-
Notifications
You must be signed in to change notification settings - Fork 17
/
syntax.R
456 lines (427 loc) · 12.1 KB
/
syntax.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
# Workflows ====
#' Create nested list for a [workflow block](https://help.github.com/en/articles/workflow-syntax-for-github-actions)
#'
#' @param name `[character(1)]`
#' giving the [name](https://help.github.com/en/articles/workflow-syntax-for-github-actions#name) of the workflow.
#' Defaults to `NULL`, for no name, in which case GitHub will use the file name.
#'
#' @param on `[character()]`
#' giving the [GitHub Event](https://help.github.com/en/articles/events-that-trigger-workflows) on which to trigger the workflow.
#' Must be a subset of [ghactions_events].
#' Defaults to `"push"`, in which case the workflow is triggered on every push event.
#' Can also be a named list as returned by [on()] for additional filters.
#'
#' @param jobs `[list()]`
#' giving a *named* list of jobs, with each list element as returned by [job()].
#'
#' @examples
#' workflow(
#' name = "Render",
#' on = "push",
#' jobs = NULL
#' )
#'
#' @family syntax
#'
#' @export
workflow <- function(name = NULL, on = "push", jobs = NULL) {
checkmate::assert_string(x = name, null.ok = TRUE, na.ok = FALSE)
if (is.character(on)) {
checkmate::assert_subset(
x = on,
choices = ghactions_events,
empty.ok = FALSE
)
} else {
checkmate::assert_list(
x = on,
any.missing = FALSE,
names = "named"
)
}
checkmate::assert_list(
x = jobs,
any.missing = FALSE,
null.ok = TRUE,
names = "unique"
)
purrr::compact(as.list(environment()))
}
#' Create nested list for an `on:` field
#'
#' @param event `[character(1)]`
#' giving the event on which to filter.
#' Must be *one* of `c("push", "pull_request", "schedule")`.
#'
#' @param ... `[character()]`
#' giving the filters on which to run.
#' Must correspond to the filters allowed by `event`.
#'
#' @details
#' See the [GitHub Actions workflow syntax](https://help.github.com/en/articles/workflow-syntax-for-github-actions) for details.
#'
#' @export
#'
#' @family syntax
#'
#' @examples
#' on(
#' event = "push",
#' branches = c("master", "releases/*")
#' )
on <- function(event, ...) {
checkmate::assert_choice(
x = event,
choices = c("push", "pull_request", "schedule")
)
rlang::set_names(x = list(purrr::compact(list(...))), nm = event)
}
#' @describeIn on filter on push event
#'
#' @param tags,branches,paths `[character()]`
#' giving the [tags, branches](https://help.github.com/en/articles/workflow-syntax-for-github-actions#onpushpull_requesttagsbranches) or [modified paths](https://help.github.com/en/articles/workflow-syntax-for-github-actions#onpushpull_requestpaths) on which to run the workflow.
#' Defaults to `NULL` for no additional filters.
#'
#' @export
on_push <- function(tags = NULL, branches = NULL, paths = NULL) {
on(event = "push", tags = tags, branches = branches, paths = paths)
}
#' @describeIn on filter on pull request
#'
#' @export
on_pull_request <- function(tags = NULL, branches = NULL, paths = NULL) {
on(event = "pull_request", tags = tags, branches = branches, paths = paths)
}
#' @describeIn on filter on schedule
#'
#' @param cron `[character(1)]`
#' giving UTC times using [POSIX cron syntax](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07).
#'
#' @export
on_schedule <- function(cron = NULL) {
on(event = "schedule", cron = cron)
}
#' Supported events to trigger GitHub actions
#'
#' You can trigger GitHub actions from these events.
#' List is taken from [official spec](https://developer.github.com/actions/creating-workflows/workflow-configuration-options/#events-supported-in-workflow-files).
#'
#' @family syntax
#'
#' @examples
#' ghactions_events
#'
#' @export
ghactions_events <- c(
"check_run",
"check_suite",
"commit_comment",
"create",
"delete",
"deployment",
"deployment_status",
"fork",
"gollum",
"issue_comment",
"issues",
"label",
"member",
"milestone",
"page_build",
"project",
"project_card",
"project_column",
"public",
"pull_request",
"pull_request_review_comment",
"pull_request_review",
"push",
"repository_dispatch",
"release",
"schedule",
"status",
"watch"
)
# Jobs ====
#' Create nested list for *one* [job](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobs)
#'
#' @param id,name `[character(1)]`
#' giving additional options for the job.
#' Defaults to `NULL`.
#'
#' @param needs `[character()]`
#' giving the jobs that must complete successfully before this job is run.
#' Defaults to `NULL` for no dependencies.
#'
#' @param 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].
#'
#' @param steps `[list()]`
#' giving an *unnamed* list of steps, with each element as returned by [step()].
#' Defaults to `NULL`.
#'
#' @param timeout_minutes `[integer(1)]`
#' giving the maximum number of minutes to let a workflow run before GitHub automatically cancels it.
#' Defaults to `NULL`.
#'
#' @param strategy `[list()]`
#' giving a named list as returned by [strategy()].
#' Defaults to `NULL`.
#'
#' @param container `[character(1)]`/`[list()]`
#' giving a published container image.
#' For advanced options, use [container()].
#' Defaults to `NULL`.
#'
#' @param 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`.
#'
#' @family syntax
#'
#' @export
job <- function(id,
name = NULL,
needs = NULL,
`runs-on` = "ubuntu-18.04",
steps = NULL,
timeout_minutes = NULL,
strategy = NULL,
container = NULL,
services = NULL) {
checkmate::assert_string(x = id, na.ok = FALSE)
checkmate::assert_string(x = name, na.ok = FALSE, null.ok = TRUE)
checkmate::assert_character(
x = needs,
any.missing = FALSE,
unique = TRUE,
null.ok = TRUE
)
checkmate::assert_choice(
x = `runs-on`,
choices = ghactions_vms,
null.ok = FALSE
)
checkmate::assert_list(
x = steps,
null.ok = TRUE,
names = "unnamed"
)
checkmate::assert_scalar(
x = timeout_minutes,
na.ok = FALSE,
null.ok = TRUE
)
checkmate::assert_list(
x = strategy,
any.missing = FALSE,
names = "unique",
null.ok = TRUE
)
if (is.character(container)) {
checkmate::assert_string(x = container, na.ok = FALSE, null.ok = TRUE)
} else {
checkmate::assert_list(
x = container,
any.missing = FALSE,
null.ok = TRUE,
names = "unique"
)
}
checkmate::assert_list(
x = services,
any.missing = FALSE,
null.ok = TRUE,
names = "unique"
)
res <- as.list(environment())
res$id <- NULL # that's the name of the list, not *in* the list
res <- purrr::compact(res)
rlang::set_names(x = list(res), nm = id)
}
#' Create nested list for the [strategy](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategy) field in [job()]
#'
#' @param matrix `[list(list(c()))]`
#' giving the values for each variable for the matrix build.
#' See [gh_matrix()] for additional options.
#' Defaults to `NULL`.
#'
#' @param fail-fast `[logical()]`
#' giving whether GitHub should cancel all in-progress jobs if any matrix job fails.
#' Defaults to `NULL`.
#'
#' @param max-parallel `[integer(1)]`
#' giving the maximum number of jobs to run simultaneously when using a matrix job strategy.
#'
#' @family syntax
#'
#' @export
strategy <- function(matrix = NULL, `fail-fast` = NULL, `max-parallel` = NULL) {
checkmate::assert_list(
x = matrix,
types = "atomicvector",
any.missing = FALSE,
names = "unique",
null.ok = TRUE
)
checkmate::assert_flag(
x = `fail-fast`,
na.ok = FALSE,
null.ok = TRUE
)
checkmate::assert_scalar(
x = `max-parallel`,
na.ok = FALSE,
null.ok = TRUE
)
purrr::compact(as.list(environment()))
}
#' Create nested list for the [matrix](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstrategy) field in [strategy()]
#'
#' @param ... `[character()]`
#' giving values for variable for the matrix build.
#'
#' @param exclude,include `[list(list(character(1)))]`
#' giving unnamed lists of combinations of variables to ex- or include.
#' Defaults to `NULL`.
#'
#' @export
#'
#' @family syntax
gh_matrix <- function(..., exclude = NULL, include = NULL) {
checkmate::assert_list(
x = exclude,
types = "character",
any.missing = FALSE,
names = "unnamed",
null.ok = TRUE
)
purrr::compact(c(list(...), as.list(environment())))
}
#' Create nested list for the [container](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idcontainer) field in [job()]
#'
#' @param image `[character(1)]`
#' giving the published docker image to use as the container to run the action.
#'
#' @param env `[list()]`
#' giving environment variables for the container as a *named* list.
#' Defaults to `NULL`.
#'
#' @param ports,volumes `[list()]`
#' giving ports to expose, and volumes for the container to use as an *unnamed* list.
#' Defaults to `NULL`.
#'
#' @param options `[character()]`
#' giving additional options.
#' Defaults to `NULL`.
#'
#' @family syntax
#'
#' @export
container <- function(image,
env = NULL,
ports = NULL,
volumes = NULL,
options = NULL) {
checkmate::assert_string(x = image, na.ok = FALSE)
checkmate::assert_list(
x = env,
types = "atomicvector",
any.missing = FALSE,
names = "unique",
null.ok = TRUE
)
purrr::walk(
.x = list(ports, volumes),
.f = checkmate::assert_list,
any.missing = FALSE,
null.ok = TRUE,
names = "unnamed"
)
checkmate::assert_character(x = options, null.ok = TRUE)
purrr::compact(as.list(environment()))
}
#' @title Virtual machines [available](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idruns-on) on GitHub Actions
#'
#' @family syntax
#'
#' @examples
#' ghactions_vms
#'
#' @export
ghactions_vms <- c(
"ubuntu-latest",
"ubuntu-18.04",
"ubuntu-16.04",
"windows-latest",
"windows-2019",
"windows-2016",
"macOS-latest",
"macOS-10.14"
)
# Steps ====
#' Create nested list for *one* [job](https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobs)
#'
#' @param id,if,name,uses,shell `[character(1)]`
#' giving additional options for the step.
#' Multiline strings are not supported.
#' Defaults to `NULL`.
#'
#' @param run `[character()]`
#' giving commands to run.
#' Will be turned into a multiline string.
#' Defaults to `NULL`.
#'
#' @param with,env `[list()]`
#' giving a named list of additional parameters.
#' Defaults to `NULL`.
#'
#' @param working-directory `[character(1)]`
#' giving the default working directory.
#' Defaults to `NULL`.
#'
#' @param continue-on-error `[logical(1)]`
#' giving whether to allow a job to pass when this step fails.
#' Defaults to `NULL`.
#'
#' @param timeout-minutes `[integer(1)]`
#' giving the maximum number of minutes to run the step before killing the process.
#' Defaults to `NULL`.
#'
#' @family syntax
#'
#' @export
step <- function(name = NULL,
id = NULL,
`if` = NULL,
uses = NULL,
run = NULL,
shell = NULL,
with = NULL,
env = NULL,
`working-directory` = NULL,
`continue-on-error` = NULL,
`timeout-minutes` = NULL) {
purrr::walk(
.x = list(id, `if`, name, uses, shell, `working-directory`),
.f = checkmate::assert_string,
na.ok = FALSE,
null.ok = TRUE
)
checkmate::assert_character(x = run, any.missing = FALSE, null.ok = TRUE)
purrr::walk(
.x = list(with, env),
.f = checkmate::assert_list,
any.missing = FALSE,
null.ok = TRUE,
names = "unique"
)
checkmate::assert_flag(x = `continue-on-error`, na.ok = FALSE, null.ok = TRUE)
checkmate::assert_scalar(x = `timeout-minutes`, na.ok = FALSE, null.ok = TRUE)
# linebreaks for run
run <- glue::glue_collapse(x = run, sep = "\n", last = "\n")
purrr::compact(as.list(environment()))
}