Skip to content

Commit

Permalink
chore: Init Actions and website
Browse files Browse the repository at this point in the history
  • Loading branch information
b-rodrigues committed Feb 12, 2024
1 parent fd7f406 commit 7b4b623
Show file tree
Hide file tree
Showing 11 changed files with 984 additions and 270 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ pkgdown/
^\.github$
^dev$
^\.here$
^LICENSE\.md$
^codecov\.yml$
49 changes: 49 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

name: R-CMD-check

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
needs: check

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
48 changes: 48 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]
release:
types: [published]
workflow_dispatch:

name: pkgdown

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4.5.0
with:
clean: false
branch: gh-pages
folder: docs
50 changes: 50 additions & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

name: test-coverage

jobs:
test-coverage:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::covr
needs: coverage

- name: Test coverage
run: |
covr::codecov(
quiet = FALSE,
clean = FALSE,
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
)
shell: Rscript {0}

- name: Show testthat output
if: always()
run: |
## --------------------------------------------------------------------
find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload test results
if: failure()
uses: actions/upload-artifact@v4
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package
50 changes: 18 additions & 32 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,37 +1,23 @@
Package: chronicler
Title: Add Logging to Functions
Version: 0.2.1
Authors@R: c(
person("Bruno", "Rodrigues", , "bruno@brodrigues.co", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0002-3211-3689")),
person("Matouš", "Eibich", "matous.eibich@seznam.cz", role = "ctb"))
Description: Decorate functions to make them return enhanced output. The enhanced output consists in an object of type
'chronicle' containing the result of the function applied to its arguments, as well as a log detailing when the function
was run, what were its inputs, what were the errors (if the function failed to run) and other useful information.
Tools to handle decorated functions are included, such as a forward pipe operator that makes chaining decorated functions possible.
Version: 0.2.1.9999
Title: Add Logging To Functions
Description: Decorate functions to make them return enhanced output. The
enhanced output consists in an object of type 'chronicle' containing the
result of the function applied to its arguments, as well as a log detailing
when the function was run, what were its inputs, what were the errors (if the
function failed to run) and other useful information. Tools to handle
decorated functions are included, such as a forward pipe operator that makes
chaining decorated functions possible.
Authors@R: c(person(given = "Bruno",
family = "Rodrigues",
role = c("aut", "cre", "cph"),
email = "bruno@brodrigues.co",
comment = c(ORCID = "0000-0002-3211-3689")),
person(given = "Matouš",
family = "Eibich",
role = "ctb",
email = "matous.eibich@seznam.cz"))
License: GPL (>= 3)
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
BugReports: https://github.com/b-rodrigues/chronicler/issues
Depends:
R (>= 4.0),
Imports:
clipr,
diffobj,
dplyr,
maybe,
rlang,
stringr,
tibble,
ggplot2
Suggests:
knitr,
lubridate,
purrr,
rmarkdown,
testthat (>= 3.1.4),
tidyr
VignetteBuilder: knitr
Config/testthat/edition: 3
LazyData: true
Loading

0 comments on commit 7b4b623

Please sign in to comment.