Skip to content

Commit f4cdb02

Browse files
committed
Reorganise NEWS for release
1 parent 61511da commit f4cdb02

File tree

1 file changed

+33
-19
lines changed

1 file changed

+33
-19
lines changed

NEWS.md

Lines changed: 33 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11

22
# vdiffr 0.1.2
33

4-
* Set minimal R version required to 3.1.0.
4+
This release makes it easier to debug failures on remote systems. It
5+
also makes vdiffr more robust to failures caused by incompatible
6+
installations: instead of failing, the tests are skipped. This
7+
prevents spurious failures on CRAN.
8+
9+
10+
## Troubleshooting on remotes
511

612
* `expect_doppelganger()` gains a `verbose` argument to print the
713
SVG files for failed cases while testing. This is useful to debug
@@ -13,24 +19,32 @@
1319
SVG files for failed cases, which is useful to debug failures on
1420
remotes.
1521

16-
* The tests are now skipped if the FreeType version used to build the
17-
comparison SVGs does not match the version installed on the system
18-
where the tests are run. This is necessary because changes in new
19-
version of FreeType might affect the computation of text extents,
20-
which then causes svglite to produce slightly different SVGs. The
21-
minor version is not taken into account so FreeType 2.7.1 is deemed
22-
compatible with 2.7.2 but not with 2.8.0.
23-
24-
In practice, this means that package contributors should only
25-
validate visual cases if their FreeType version matches the one of
26-
the package maintainer. Also, the maintainer must update the version
27-
recorded in the package repository (in the file
28-
`./tests/figs/deps.txt`) when FreeType has been updated on their
29-
system. Running `vdiffr::validate_cases()` updates the dependency
30-
file even if there are no visual case to update.
31-
32-
In the future, we may provide a version of vdiffr statically
33-
compiled with a specific version of FreeType to prevent these issues.
22+
23+
## Handling of incompatible systems
24+
25+
The tests are now skipped if the FreeType version used to build the
26+
comparison SVGs does not match the version installed on the system
27+
where the tests are run. This is necessary because changes in new
28+
version of FreeType might affect the computation of text extents,
29+
which then causes svglite to produce slightly different SVGs. The
30+
minor version is not taken into account so FreeType 2.7.1 is deemed
31+
compatible with 2.7.2 but not with 2.8.0.
32+
33+
In practice, this means that package contributors should only
34+
validate visual cases if their FreeType version matches the one of
35+
the package maintainer. Also, the maintainer must update the version
36+
recorded in the package repository (in the file
37+
`./tests/figs/deps.txt`) when FreeType has been updated on their
38+
system. Running `vdiffr::validate_cases()` updates the dependency
39+
file even if there are no visual case to update.
40+
41+
In the future, we may provide a version of vdiffr statically
42+
compiled with a specific version of FreeType to prevent these issues.
43+
44+
45+
## Other changes
46+
47+
* The minimal R version required by vdiffr is now R 3.1.0.
3448

3549

3650
# vdiffr 0.1.1

0 commit comments

Comments
 (0)