Octolog provides a complete1 API for Github workflow commands that makes it easy to create powerful Github Actions that create readable logs.

and makes it possible to signal conditions from within R that will create annotations when used within Github Actions but raise normal R conditions when used interactively. Annotations on files of a PR

Installation

You can install the development version of octolog with either of these options:

pak::pak("assignUser/octolog")
devtools::install_github("assignUser/octolog")

What are Github Actions?

Github Actions is a powerful,free2 CI service integrated into every repository on Github. You can use actions created by other users (e.g. the very popular r-lib/actions collection of R related actions) or create your own customized workflow that fits your needs.

Example

The best way to see how {octolog} works, is in an actual workflow. For more information please see the website and the introductory vignette.

Code of Conduct

Please note that the octolog project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.


  1. The only exception is save-state which can only be used in JavaScript actions.↩︎

  2. For public repositories.↩︎