update_news_md function

Update NEWS.md for a new release

Modify the NEWS.md file of a package to replace the "Unreleased"

section with a new version heading and update GitHub comparison links.

update_news_md(path, version_number, verbose = TRUE)

Arguments

• path: [character ] Path to the package root directory.
• version_number: [character ] Current version number string (e.g. "1.2.3").
• verbose: [logical ] Whether to print current and new remote fields (default: TRUE).

Returns

Invisibly returns TRUE if the file was successfully updated.

Details

The argument version_number is the new version number to update the changelog.

Examples

path_rjd3workspace <- file.path(tempdir(), "rjd3workspace")
file.copy(
    from = system.file("rjd3workspace", package = "releaser"),
    to = dirname(path_rjd3workspace),
    recursive = TRUE
)

update_news_md(path = path_rjd3workspace, version_number = "1.2.3")