https://github.com/assignUser/octolog

Better Github Action Logging
https://github.com/assignUser/octolog

actions ci r rstats workflows

Last synced: 3 months ago
JSON representation

Better Github Action Logging

• Host: GitHub
• URL: https://github.com/assignUser/octolog
• Owner: assignUser
• License: other
• Created: 2022-01-23T16:07:24.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-31T02:57:47.000Z (over 1 year ago)
• Last Synced: 2024-06-05T00:39:59.219Z (5 months ago)
• Topics: actions, ci, r, rstats, workflows
• Language: R
• Homepage: https://jacob.wujciak.de/octolog
• Size: 346 KB
• Stars: 13
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

• jimsghstars - assignUser/octolog - Better Github Action Logging (R)

README

        
---

output: 

    github_document: default

---

# octolog

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

[![R-CMD-check](https://github.com/assignUser/octolog/workflows/R-CMD-check/badge.svg)](https://github.com/assignUser/octolog/actions)

[![pkgcheck](https://github.com/assignUser/octolog/actions/workflows/pkgcheck.yaml/badge.svg)](https://github.com/assignUser/octolog/actions/workflows/pkgcheck.yaml)

[![Coverage Status](https://coveralls.io/repos/github/assignUser/octolog/badge.svg?branch=main)](https://coveralls.io/github/assignUser/octolog?branch=main)

[![DOI](https://zenodo.org/badge/451156961.svg)](https://zenodo.org/badge/latestdoi/451156961)

Octolog provides a complete[^1] API for GitHub [workflow commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) that makes it easy to create powerful GitHub Actions that create readable logs. 

Additionally it is possible to signal conditions with octolog from R that will create annotations when used within GitHub Actions but raise normal R conditions

when used interactively.

![Annotations on files of a PR](man/figures/error.png)

[^1]: The only exception is [`save-state`](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#sending-values-to-the-pre-and-post-actions) which can only be used in JavaScript actions. 

## Installation

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

``` r

pak::pak("assignUser/octolog")

devtools::install_github("assignUser/octolog")

```

## What are *GitHub Actions*?

[GitHub Actions](https://github.com/features/actions) is a powerful,free[^2] [CI](https://devguide.ropensci.org/ci.html) service integrated into every repository on GitHub. You can use actions created by other users (e.g. the very popular [r-lib/actions](https://github.com/r-lib/actions) collection of R related actions) or create your own customized workflow that fits your needs.

[^2]: For public repositories.

## Example

The best way to see how {octolog} works, is in an actual [workflow](https://github.com/assignUser/octolog/actions/workflows/test-octolog.yaml). For more information please see the [website](assignUser.github.io/octolog) and the [introductory vignette](https://jacob.wujciak.de/octolog/articles/octolog.html).

## Code of Conduct

Please note that the octolog project is released with a [Contributor Code of Conduct](https://jacob.wujciak.de/octolog/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.