-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use coveralls instead of codecov (#21)
* Update test-coverage.yaml * update test snapshot * use coveralls action to submit * add xml2 for conversion * update badge
- Loading branch information
1 parent
60c03af
commit f17ff3a
Showing
4 changed files
with
91 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,66 @@ | ||
|
||
<!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
||
# octolog | ||
|
||
<!-- badges: start --> | ||
|
||
[![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) | ||
[![Codecov test | ||
coverage](https://codecov.io/gh/assignUser/octolog/branch/main/graph/badge.svg)](https://app.codecov.io/gh/assignUser/octolog?branch=main) | ||
[![DOI](https://zenodo.org/badge/451156961.svg)](https://zenodo.org/badge/latestdoi/451156961) | ||
<!-- badges: end --> | ||
|
||
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) | ||
|
||
## 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. | ||
|
||
## 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. | ||
|
||
[^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. | ||
|
||
[^2]: For public repositories. | ||
|
||
<!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
||
# octolog | ||
|
||
<!-- badges: start --> | ||
|
||
[![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) | ||
<!-- badges: end --> | ||
|
||
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) | ||
|
||
## 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. | ||
|
||
## 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. | ||
|
||
[^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. | ||
|
||
[^2]: For public repositories. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters