-
Notifications
You must be signed in to change notification settings - Fork 755
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support NEWS in Rd and md formats and under inst
Mirrors the search path documented in utils::news() for NEWS files. Uses the internal machinery of tools to build news databases.
- Loading branch information
Showing
2 changed files
with
73 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
test_that("can read NEWS.md in root directory", { | ||
skip_on_cran() | ||
|
||
pkg <- local_package_create() | ||
suppressMessages(usethis::with_project(pkg, use_news_md())) | ||
|
||
expect_no_error(show_news(pkg)) | ||
}) | ||
|
||
test_that("can read NEWS.Rd in inst directory", { | ||
skip_on_cran() | ||
|
||
pkg <- local_package_create() | ||
|
||
dir_create(pkg, "inst") | ||
write(r"[\name{NEWS} | ||
\title{News for Package 'test'} | ||
\section{CHANGES IN test VERSION 0.0.1}{ | ||
\itemize{ | ||
\item First version | ||
} | ||
}]", path(pkg, "inst", "NEWS.Rd")) | ||
|
||
expect_no_error(show_news(pkg)) | ||
}) | ||
|
||
test_that("can read NEWS in inst directory", { | ||
skip_on_cran() | ||
|
||
pkg <- local_package_create() | ||
|
||
dir_create(pkg, "inst") | ||
write("v0.1-1 (2024-01-09)\n\n o first release", path(pkg, "inst", "NEWS")) | ||
|
||
expect_no_error(show_news(pkg)) | ||
}) | ||
|
||
test_that("fails when NEWS is missing", { | ||
skip_on_cran() | ||
|
||
pkg <- local_package_create() | ||
|
||
expect_error(show_news(pkg)) | ||
}) | ||
|
||
test_that("fails when NEWS is improperly formatted", { | ||
skip_on_cran() | ||
|
||
pkg <- local_package_create() | ||
suppressMessages(usethis::with_project(pkg, use_news_md())) | ||
|
||
dir_create(pkg, "inst") | ||
file_create(pkg, "inst", "NEWS.Rd") | ||
|
||
expect_error(show_news(pkg)) | ||
}) |