Skip to content

Commit 2ad21e1

Browse files
committed
Mention changes in NEWS
1 parent b326120 commit 2ad21e1

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

NEWS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# vdiffr (development version)
22

3+
This release includes two major changes:
4+
5+
1. The internal SVG engine has been updated. This means you will have
6+
to regenerate all existing snapshots.
7+
8+
2. The snapshot management system now uses testthat (see
9+
https://testthat.r-lib.org/articles/snapshotting.html). Most of the
10+
R and javascript code has been removed from vdiffr as a consequence.
11+
vdiffr now serves as a reproducible SVG generation engine for
12+
testthat snapshots.
13+
14+
15+
## Migration of existing snapshots
16+
17+
There are two steps to update your snapshots to vdiffr 1.0.
18+
19+
1. This step is optional. Install the github-only 0.4.0 version of
20+
vdiffr with `remotes::install_github("r-lib/[email protected]")`. This
21+
release only contains the new SVG engine. Review the snapshot
22+
changes as usual with `vdiffr::manage_cases()`.
23+
24+
2. Install vdiffr 1.0.0 from CRAN, delete the `tests/figs` directory,
25+
run `devtools::test()`, and then `testthat::snapshot_review()`.
26+
27+
328
# vdiffr 0.4.0
429

530
This is a github-only release that is meant to help you migrate from

0 commit comments

Comments
 (0)