|
1 | | - |
2 | | -<!-- README.md is generated from README.Rmd. Please edit that file --> |
3 | | - |
4 | | -# octolog |
5 | | - |
6 | | -<!-- badges: start --> |
7 | | - |
8 | | -[](https://www.repostatus.org/#active) |
11 | | -[](https://github.com/assignUser/octolog/actions) |
12 | | -[](https://github.com/assignUser/octolog/actions/workflows/pkgcheck.yaml) |
13 | | -[](https://app.codecov.io/gh/assignUser/octolog?branch=main) |
15 | | -[](https://zenodo.org/badge/latestdoi/451156961) |
16 | | -<!-- badges: end --> |
17 | | - |
18 | | -Octolog provides a complete[^1] API for GitHub [workflow |
19 | | -commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) |
20 | | -that makes it easy to create powerful GitHub Actions that create |
21 | | -readable logs. |
22 | | - |
23 | | -Additionally it is possible to signal conditions with octolog from R |
24 | | -that will create annotations when used within GitHub Actions but raise |
25 | | -normal R conditions when used interactively.  |
27 | | - |
28 | | -## Installation |
29 | | - |
30 | | -You can install the development version of octolog with either of these |
31 | | -options: |
32 | | - |
33 | | -``` r |
34 | | -pak::pak("assignUser/octolog") |
35 | | -devtools::install_github("assignUser/octolog") |
36 | | -``` |
37 | | - |
38 | | -## What are *GitHub Actions*? |
39 | | - |
40 | | -[GitHub Actions](https://github.com/features/actions) is a |
41 | | -powerful,free[^2] [CI](https://devguide.ropensci.org/ci.html) service |
42 | | -integrated into every repository on GitHub. You can use actions created |
43 | | -by other users (e.g. the very popular |
44 | | -[r-lib/actions](https://github.com/r-lib/actions) collection of R |
45 | | -related actions) or create your own customized workflow that fits your |
46 | | -needs. |
47 | | - |
48 | | -## Example |
49 | | - |
50 | | -The best way to see how {octolog} works, is in an actual |
51 | | -[workflow](https://github.com/assignUser/octolog/actions/workflows/test-octolog.yaml). |
52 | | -For more information please see the |
53 | | -[website](assignUser.github.io/octolog) and the [introductory |
54 | | -vignette](https://jacob.wujciak.de/octolog/articles/octolog.html). |
55 | | - |
56 | | -## Code of Conduct |
57 | | - |
58 | | -Please note that the octolog project is released with a [Contributor |
59 | | -Code of |
60 | | -Conduct](https://jacob.wujciak.de/octolog/CODE_OF_CONDUCT.html). By |
61 | | -contributing to this project, you agree to abide by its terms. |
62 | | - |
63 | | -[^1]: The only exception is |
64 | | - [`save-state`](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#sending-values-to-the-pre-and-post-actions) |
65 | | - which can only be used in JavaScript actions. |
66 | | - |
67 | | -[^2]: For public repositories. |
| 1 | + |
| 2 | +<!-- README.md is generated from README.Rmd. Please edit that file --> |
| 3 | + |
| 4 | +# octolog |
| 5 | + |
| 6 | +<!-- badges: start --> |
| 7 | + |
| 8 | +[](https://www.repostatus.org/#active) |
| 11 | +[](https://github.com/assignUser/octolog/actions) |
| 12 | +[](https://github.com/assignUser/octolog/actions/workflows/pkgcheck.yaml) |
| 13 | +[](https://coveralls.io/github/assignUser/octolog?branch=main) |
| 15 | +[](https://zenodo.org/badge/latestdoi/451156961) |
| 16 | +<!-- badges: end --> |
| 17 | + |
| 18 | +Octolog provides a complete[^1] API for GitHub [workflow |
| 19 | +commands](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions) |
| 20 | +that makes it easy to create powerful GitHub Actions that create |
| 21 | +readable logs. |
| 22 | + |
| 23 | +Additionally it is possible to signal conditions with octolog from R |
| 24 | +that will create annotations when used within GitHub Actions but raise |
| 25 | +normal R conditions when used interactively.  |
| 27 | + |
| 28 | +## Installation |
| 29 | + |
| 30 | +You can install the development version of octolog with either of these |
| 31 | +options: |
| 32 | + |
| 33 | +``` r |
| 34 | +pak::pak("assignUser/octolog") |
| 35 | +devtools::install_github("assignUser/octolog") |
| 36 | +``` |
| 37 | + |
| 38 | +## What are *GitHub Actions*? |
| 39 | + |
| 40 | +[GitHub Actions](https://github.com/features/actions) is a |
| 41 | +powerful,free[^2] [CI](https://devguide.ropensci.org/ci.html) service |
| 42 | +integrated into every repository on GitHub. You can use actions created |
| 43 | +by other users (e.g. the very popular |
| 44 | +[r-lib/actions](https://github.com/r-lib/actions) collection of R |
| 45 | +related actions) or create your own customized workflow that fits your |
| 46 | +needs. |
| 47 | + |
| 48 | +## Example |
| 49 | + |
| 50 | +The best way to see how {octolog} works, is in an actual |
| 51 | +[workflow](https://github.com/assignUser/octolog/actions/workflows/test-octolog.yaml). |
| 52 | +For more information please see the |
| 53 | +[website](assignUser.github.io/octolog) and the [introductory |
| 54 | +vignette](https://jacob.wujciak.de/octolog/articles/octolog.html). |
| 55 | + |
| 56 | +## Code of Conduct |
| 57 | + |
| 58 | +Please note that the octolog project is released with a [Contributor |
| 59 | +Code of Conduct](https://jacob.wujciak.de/octolog/CODE_OF_CONDUCT.html). |
| 60 | +By contributing to this project, you agree to abide by its terms. |
| 61 | + |
| 62 | +[^1]: The only exception is |
| 63 | + [`save-state`](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#sending-values-to-the-pre-and-post-actions) |
| 64 | + which can only be used in JavaScript actions. |
| 65 | + |
| 66 | +[^2]: For public repositories. |
0 commit comments