Skip to content

Commit

Permalink
Small updates to Readme, description and test coverage
Browse files Browse the repository at this point in the history
  • Loading branch information
andrie committed Oct 1, 2021
1 parent 08e22de commit 974baa2
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 27 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
@@ -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}
10 changes: 5 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Authors@R:
role = c("aut", "cre"),
email = "[email protected]")
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
Expand Down
5 changes: 2 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ knitr::opts_chunk$set(
# mailmerge <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![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)
<!-- badges: end -->

Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,9 @@

<!-- badges: start -->

[![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)
<!-- badges: end -->
Expand Down Expand Up @@ -107,7 +104,6 @@ if (interactive()) {
dat %>%
mail_merge(msg)
#> Sent preview to viewer

if (interactive()) {
dat %>%
mail_merge(msg) %>%
Expand Down
19 changes: 6 additions & 13 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 974baa2

Please sign in to comment.