ghactions (version 0.4.1)

document: Document Package

Description

This GitHub action installs R package dependencies from a DESCRIPTION at the repository root.

Thin wrapper around GitHub actions.

Usage

document(IDENTIFIER = "Document Package", needs = NULL, args = NULL)

Arguments

IDENTIFIER

[character(1)] giving the name of the action or workflow block.

Used:

  • as an informative label on GitHub.com,

  • in the needs fields of other action blocks to model the workflow graph,

  • in the resolves fields of other workflow blocks to model the workflow graph.

needs

[character()] giving the actions (by their IDENTIFIERs) that must complete successfully before this action will be invoked. Defaults to NULL for no upstream dependencies.

args

[character()] giving the arguments to pass to the action. Arguments get appended to the last command in ENTRYPOINT. Defaults to NULL for no arguments.

...

arguments passed on to other methods, not currently used.

Details

These functions are for advanced users knowledgeable about GitHub actions. Novice users may be better served by the complete templates in workflows.

These functions provide very thin wrappers around existing GitHub actions, including actions from other repositories. Essentially, they just create lists ready to be ingested by make_action_block(), which then turns these R lists into valid GitHub actions syntax blocks.

For documentation on these actions, consult their respective README.mds linked in the below. Some variants of these action wrappers include sensible defaults for frequent uses in R.

The uses field is always hardcoded to a particular commit or tag of the underlying github action to ensure compatibility.

To render an action block completely from scratch, you can always use the templating function make_action_block().

See Also

Other actions: docker_cli, filter, firebase, ghpages, install_deps, netlify, rscript_byod, rsync