releaser (version 1.0.0)

update_news_md: Update NEWS.md for a new release

Description

Modify the NEWS.md file of a package to replace the "Unreleased" section with a new version heading and update GitHub comparison links.

Usage

update_news_md(path, version_number, verbose = TRUE)

Value

Invisibly returns TRUE if the file was successfully updated.

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).

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")