From 974baa2dde508d7dc89984d5624c953d56e395bd Mon Sep 17 00:00:00 2001 From: Andrie Date: Fri, 1 Oct 2021 11:07:13 +0000 Subject: [PATCH] Small updates to Readme, description and test coverage --- .github/workflows/test-coverage.yaml | 30 ++++++++++++++++++++++++++++ DESCRIPTION | 10 +++++----- README.Rmd | 5 ++--- README.md | 8 ++------ cran-comments.md | 19 ++++++------------ 5 files changed, 45 insertions(+), 27 deletions(-) create mode 100644 .github/workflows/test-coverage.yaml diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml new file mode 100644 index 0000000..3c0da1c --- /dev/null +++ b/.github/workflows/test-coverage.yaml @@ -0,0 +1,30 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/master/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@v2 + + - uses: r-lib/actions/setup-r@v1 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v1 + with: + extra-packages: covr + + - name: Test coverage + run: covr::codecov() + shell: Rscript {0} diff --git a/DESCRIPTION b/DESCRIPTION index e3d92be..4edb170 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,11 +7,11 @@ Authors@R: role = c("aut", "cre"), email = "apdevries@gmail.com") Description: Perform a mail merge (mass email) using the message defined in - markdown, the recipients in a csv, and gmail as the mailing engine. With - this package you can parse markdown documents as the body of email, and the - 'yaml' header to specify the subject line of the email. Any '{}' braces in - the email will be encoded with 'glue::glue()'. You can preview the email in - the RStudio viewer pane, and send (draft) email using 'gmailr'. + markdown, the recipients in a 'csv' file, and gmail as the mailing engine. + With this package you can parse markdown documents as the body of email, and + the 'yaml' header to specify the subject line of the email. Any '{}' braces + in the email will be encoded with 'glue::glue()'. You can preview the email + in the RStudio viewer pane, and send (draft) email using 'gmailr'. License: MIT + file LICENSE URL: https://andrie.github.io/mailmerge/, https://github.com/andrie/mailmerge BugReports: https://github.com/andrie/mailmerge/issues diff --git a/README.Rmd b/README.Rmd index d55f3c3..9548aec 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,9 +18,8 @@ knitr::opts_chunk$set( # mailmerge -[![R build status](https://github.com/andrie/mailmerge/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/mailmerge/actions) -[![Travis build status](https://travis-ci.org/andrie/mailmerge.svg?branch=master)](https://travis-ci.org/andrie/mailmerge) -[![Codecov test coverage](https://codecov.io/gh/andrie/mailmerge/branch/master/graph/badge.svg)](https://codecov.io/gh/andrie/mailmerge?branch=master) +[![R-CMD-check](https://github.com/andrie/mailmerge/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/mailmerge/actions) +[![Codecov test coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://codecov.io/gh/andrie/mailmerge?branch=main) [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) diff --git a/README.md b/README.md index eeb476d..f055d88 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,9 @@ -[![R build -status](https://github.com/andrie/mailmerge/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/mailmerge/actions) -[![Travis build -status](https://travis-ci.org/andrie/mailmerge.svg?branch=master)](https://travis-ci.org/andrie/mailmerge) +[![R-CMD-check](https://github.com/andrie/mailmerge/workflows/R-CMD-check/badge.svg)](https://github.com/andrie/mailmerge/actions) [![Codecov test -coverage](https://codecov.io/gh/andrie/mailmerge/branch/master/graph/badge.svg)](https://codecov.io/gh/andrie/mailmerge?branch=master) +coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://codecov.io/gh/andrie/mailmerge?branch=main) [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) @@ -107,7 +104,6 @@ if (interactive()) { dat %>% mail_merge(msg) #> Sent preview to viewer - if (interactive()) { dat %>% mail_merge(msg) %>% diff --git a/cran-comments.md b/cran-comments.md index f927562..90e01d1 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,18 +1,11 @@ -## Fixes CRAN review comments +## Small updates and bug fixes -During CRAN review, two issues were highlight, both are now fixed: - -* Use non-directional quote in the DESCRIPTION file -* Document \value for pipe.Rd +No notes or warnings. ## Test environments -* local R installation, R 4.0.3 -* ubuntu 16.04 (on travis-ci), R 4.0.3 -* win-builder (devel) - -## R CMD check results - -0 errors | 0 warnings | 1 note +* local R installation, R 4.1.1 +* ubuntu 18.04 (on Github Actions), with R-oldrel-4 through R-devel +* Windows latest on Github actions +* MacOS latest on Github actions -* This is a new release.