Skip to content

Commit

Permalink
Polish news and cran comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jimhester committed Oct 24, 2018
1 parent c920b73 commit d78cd80
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 25 deletions.
62 changes: 44 additions & 18 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
# devtools 2.0.0

Devtools 2.0.0 is a _major_ release that contains work from the past year and a
half, since the major devtools release (1.13.0).

This release splits the functionality in **devtools** into a number of smaller
packages which are simpler to develop and also easier for other packages to
depend on. In particular the following packages have been spun off in what we
are calling the 'conscious uncoupling' of **devtools**.

* remotes: Installing packages (i.e. `install_github()`).
* pkgbuild: Building binary packages (including checking if build tools are available) (i.e. `build()`).
* pkgload: Simulating package loading (i.e. `load_all()`).
* rcmdcheck: Running R CMD check and reporting the results (i.e. `check()`).
* revdepcheck: Running R CMD check on all reverse dependencies, and figuring
out what's changed since the last CRAN release (i.e. `revdep_check()`).
* sessioninfo: R session info (i.e. `session_info()`).
* usethis: Automating package setup (i.e. `use_test()`).

devtools will remain the main package developers will interact with when
writing R packages; it will just rely on these other packages internally
for most of the functionality.

## Breaking changes

There have been a number of breaking changes in this release, while this will
cause some short term pain for users it will result in a easier to understand
API in the future, so we feel the tradeoff is worthwhile.

* `devtools::install()` arguments have been changed as follows.
- `local` -> `build`
- `force_deps` -> `force`
Expand All @@ -25,36 +50,39 @@

* `RCMD()`, `clean_source()`, `eval_clean()` and `evalq_clean()` have been
removed. These functions never worked terribly well, and have been replaced
by the much better functions in callr.
by the much better functions in **callr**.

* `build_win()` has been renamed to `check_win_release()`, `check_win_devel()`,
`check_win_oldrelease()` (#1598).
and `check_win_oldrelease()` (#1598).

## Deprecated functions

* Infrastructure functions (`use_*`) now use the implementations in **usethis**
and the versions in devtools are deprecated. If you use these from a package
and the versions in **devtools** are deprecated. If you use these from a package
you should switch your package to depend on **usethis** directly instead.

* The `revdep_check_*` functions have been deprecated in favor of the
**revdepcheck** package.

* `system_check()` and `system_output()` have been deprecated in factor of the
**processx** package.

## Major changes

* All `install_*()` functions are now re-exported from remotes rather than being defined in devtools.
* All `install_*()` functions are now re-exported from **remotes** rather than
being defined in **devtools**

* devtools now depends on roxygen2 6.1.0: this considerably simplifies
* **devtools** now depends on **roxygen2** 6.1.0: this considerably simplifies
`devtools::document()` and makes it more consistent with
`roxygen2::roxygenise()`.

* Bioconductor support now provided by the BiocManager CRAN package instead of
BiocInstaller (for R versions 3.5+) (#1833).

* `test_file()` function added to test one or more files from a package
(#1755).

* New `test_coverage()` provides helper to compute test coverage using covr
(#1628).
* `test_coverage()` function added to provide a helper to compute test coverage
using **covr** (#1628).

* `test_file()` and `test_coverage_file()` now have RStudio addins (#1650)

* `test_file_coverage()` function added to show the test coverage of one or
more files from a package. (#1755).
Expand All @@ -74,22 +102,22 @@ you should switch your package to depend on **usethis** directly instead.
`load_code()`, `load_dll()`, `ns_env()`, `parse_ns_file()`, `pkg_env()`.
These functions are primarily for internal use.

`load_all()` and `unload()` have been moved to pkgload, but devtools
`load_all()` and `unload()` have been moved to pkgload, but **devtools**
provides shims since these are commonly used.

* `find_rtools()`, `setup_rtools()`, `has_devel()`, `compiler_flags()`,
`build()` and `with_debug()` have moved to the new **pkgbuild** package.
`build()` and `with_debug()` are re-exported by devtools.
`build()` and `with_debug()` are re-exported by **devtools**

* The `spell_check()` code has been moved into the new **spelling** package and
has thereby gained support for vignettes and package wordlists. The devtools
has thereby gained support for vignettes and package wordlists. The **devtools**
function now wraps `spelling::spell_check_package()`.

## Bugfixes and additional changes
## Minor improvements and fixes

* `check_win_*()` now build the package with `manual = TRUE` by default (#1890).

* `check()` output now works more nicely with recent changes to rcmdcheck (#1874).
* `check()` output now works more nicely with recent changes to **rcmdcheck** (#1874).

* `reload()` now reloads loaded but not attached packages as well as attached ones.

Expand All @@ -109,7 +137,7 @@ you should switch your package to depend on **usethis** directly instead.
* `remote_sha.github()` now correctly looks up SHA in private repositories
(#1827, @renozao).

* devtools `use_*()` functions now temporarily set the active usethis project
* **devtools** `use_*()` functions now temporarily set the active **usethis** project
if given a pkg argument that is not the current directory. This provides
backwards compatibility with previous behavior (#1823).

Expand All @@ -128,8 +156,6 @@ you should switch your package to depend on **usethis** directly instead.
* `test()` now sets `useFancyQuotes = FALSE` to better mimic the environment tests
are run under with `R CMD check` (#1735).

* `test_file()` and `test_coverage_file()` now have RStudio addins (#1650)

* `test()` no longer passes encoding argument to `testthat::test_dir()` (#1776)

* `install_url()` can now install package binaries on windows (#1765)
Expand Down
11 changes: 4 additions & 7 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
This is a point release fixing failing tests on CRAN.

This release also makes Jim Hester the new maintainer of devtools. Hadley
Wickham will need to approve the change <[email protected]>.
This release adds additional functionality and also addresses check failures in R-devel

## Test environments

Expand Down Expand Up @@ -39,9 +36,9 @@ should change their dependency from devtools to usethis.
In all cases either pull requests were sent to the authors to fix the errors or
maintainers contacted via email.

- assertive\* - emailed on 2018-09-19, maintainer responded on same day saying they would
update the packages.
- assertive\* - emailed the maintainer on 2018-09-19, maintainer responded on
same day saying they would update the packages.
- pacman - Already fixed in devel version - https://github.com/trinker/pacman/issues/113
- PSPManalysis - https://github.com/cran/PSPManalysis/blob/729b7b05b28a95b924773e17971589824fe7dd05/R/setup.R#L2-L13 - (emailed 2018-10-09)
- testthat - https://github.com/r-lib/testthat/pull/803
- testthat - https://github.com/r-lib/testthat/pull/803 - now on CRAN as testthat 2.0.1
- unitizer - https://github.com/brodieG/unitizer/pull/255

0 comments on commit d78cd80

Please sign in to comment.