Life-cycle Policy Prior to
v1.0.0
Be aware that this package produces code that enters into your package's R documentation files. Until
testex
reaches1.0.0
, there are no guarantees for a stable interface, which means your package's tests written in documentation files may fail if interface changes.
Documentation syntax changes. Documentation will be need to be re-
roxygenize
'd or otherwise updated.
-
Changes syntax of tests to minimize reliance on
testex
namespace consistency across versions. Instead of usingtestex(with_srcref(..))
andtestthat_block(test_that(.., with_srcref(..)))
, both interfaces are now handled viatestex()
with an addedstyle
parameter:testex(style = "testthat", srcref = "fn.R:10:11", { code })
This syntax is intended to be more resilient to changes to keep your tests from relying too heavily on an unchanging
testex
function interface.
-
Adds configuration (
Config/testex/options
) field"version"
, which is automatically updated when a newer version oftestex
is first used.This field is checked to decide whether the currently loaded version of
testex
is capable of re-running your tests.Currently, a conservative approach is taken. If there is a version mismatch,
testex
will suggest updating when run independently using a testing framework and will disabletestex
testing duringR CMD check
to avoid causing downstream test failures as the API changes. However, this means thattestex
tests will be ineffective if your package is out-of-date with the releasedtestex
version onCRAN
Past a
v1.0.0
release, this behavior will be relaxed to check for a compatible major version.
- Initial CRAN submission