From 14e2454c315c41073fc91dbecaba9d4c65836c7a Mon Sep 17 00:00:00 2001 From: Colin Gillespie Date: Sun, 14 Mar 2021 19:48:14 +0000 Subject: [PATCH] Bug: when exlcuding files --- DESCRIPTION | 2 +- NEWS.md | 3 +++ R/check_lintr.R | 2 +- README.md | 45 ++++++++++++++++++++++----------------------- 4 files changed, 27 insertions(+), 25 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 28a5c7a..14a4e05 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: inteRgrate Title: Opinionated Package Coding Styles -Version: 1.0.10 +Version: 1.0.11 Authors@R: person(given = "Jumping", family = "Rivers", diff --git a/NEWS.md b/NEWS.md index 4dda2d5..895ba24 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,6 @@ +# inteRgrate 1.0.11 _2021-03-14_ + * Bug: Previous bug fix caused issues + # inteRgrate 1.0.10 _2021-03-11_ * Bug: don't lint renv or packrat folders diff --git a/R/check_lintr.R b/R/check_lintr.R index e479f9d..2b98200 100644 --- a/R/check_lintr.R +++ b/R/check_lintr.R @@ -16,7 +16,7 @@ get_exclusions = function() { lint_files = function() { lint_errors = FALSE - lints = lintr::lint_package(list("R/RcppExports.R", "renv", "packrat")) + lints = lintr::lint_package(exclusions = list("R/RcppExports.R", "renv", "packrat")) if (length(lints) > 0) { lapply(lints, print) lint_errors = TRUE diff --git a/README.md b/README.md index b0a77e9..5865585 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,13 @@ [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) -[![Build -Status](https://travis-ci.org/jumpingrivers/inteRgrate.png?branch=master,dev)](https://travis-ci.org/jumpingrivers/inteRgrate) [![CRAN](http://www.r-pkg.org/badges/version/inteRgrate)](https://cran.r-project.org/package=inteRgrate) [![Codecov test coverage](https://codecov.io/gh/jumpingrivers/inteRgrate/branch/master/graph/badge.svg)](https://codecov.io/gh/jumpingrivers/inteRgrate?branch=master) +[![R-CMD-check](https://github.com/jumpingrivers/inteRgrate/workflows/R-CMD-check/badge.svg)](https://github.com/jumpingrivers/inteRgrate/actions) The goal of inteRgrate is to provide an very opinionated set of rules @@ -26,12 +25,12 @@ Rivers](https://www.jumpingrivers.com) on GitHub and GitLab. The rationale behind this package is - - While checking R packages on travis is easy, support for GitLab (and +- While checking R packages on travis is easy, support for GitLab (and others) is lacking. - - When developing a package, sometimes we want to specify the exact +- When developing a package, sometimes we want to specify the exact number of NOTES and WARNINGS we expect/allow. - - Having a consistent system for different CI is desirable. - - For our CI steps, we have a few other checks that we tend to +- Having a consistent system for different CI is desirable. +- For our CI steps, we have a few other checks that we tend to implement, e.g. lints, not using imports within namespaces. This package is still being developed, but we are now actively using it, @@ -54,26 +53,26 @@ The package is meant to be used within a continuous integration framework, e.g. travis, GitLab runner. This package contains a number functions that are useful for CI: - - `check_pkg()` - installs package dependencies, builds & installs the +- `check_pkg()` - installs package dependencies, builds & installs the package, before running package check. By default, **any** notes or warnings will raise an error message. This can be changed by setting the environment variables `ALLOWED_NOTES` and `ALLOWED_WARNINGS`. - - `check_lintr()` - runs lintr on the package, README.Rmd and +- `check_lintr()` - runs lintr on the package, README.Rmd and vignettes. - - `check_namespace()` - check for instances of `import()` in the +- `check_namespace()` - check for instances of `import()` in the NAMESPACE file. By default, no imports are allowed. This can be changed via the environment variable `NO_IMPORTS` - - `check_r_filenames()` - ensures file extensions are `.R` and all +- `check_r_filenames()` - ensures file extensions are `.R` and all names are lower case. - - `check_version()` - ensures that the package description has been +- `check_version()` - ensures that the package description has been updated. - - `check_gitignore()` - .gitignore contains standard files. - - `check_readme()` - checks README.Rmd timestamps - - `check_tidy_description()` - ensure that the DESCRIPTION file is +- `check_gitignore()` - .gitignore contains standard files. +- `check_readme()` - checks README.Rmd timestamps +- `check_tidy_description()` - ensure that the DESCRIPTION file is tidy, via `usethis::use_tidy_description()` - - `check_file_permissions()`, `check_line_breaks()` - ensures that +- `check_file_permissions()`, `check_line_breaks()` - ensures that linux line breaks are used and file permissions are sensible. - - `create_tag()` - autotag via the CI. +- `create_tag()` - autotag via the CI. See the help pages for customisation. @@ -94,7 +93,7 @@ environment variables. - ALLOWED_WARNINGS=0 - ALLOWED_NOTES=0 - NO_IMPORTS=0 - + script: - Rscript -e "inteRgrate::check_via_env(default = 'true')" @@ -105,11 +104,11 @@ environment variables. ALLOWED_WARNINGS: 0 ALLOWED_NOTES: 0 NO_IMPORTS: 0 - + before_script: - Rscript -e "install.packages('remotes')" - Rscript -e "remotes::install_github('jumpingrivers/inteRgrate')" - + check: script: - Rscript -e "inteRgrate::check_via_env(default = 'true')" @@ -126,17 +125,17 @@ check_r_filenames() ## Other information - - ROpensci are developing a related package - +- ROpensci are developing a related package - [tic](https://github.com/ropenscilabs/tic). The [tic](https://github.com/ropenscilabs/tic) package aims to specify the CI environment purely by an R script. - - If you have any suggestions or find bugs, please use the github +- If you have any suggestions or find bugs, please use the github [issue tracker](https://github.com/jumpingrivers/inteRgrate/issues) - - Feel free to submit pull requests +- Feel free to submit pull requests ------ +------------------------------------------------------------------------ Development of this package was supported by [Jumping Rivers](https://www.jumpingrivers.com)