Package 'releaser'

Change the Remotes field in DESCRIPTION

Description

Update the Remotes field of a package DESCRIPTION file so that dependencies point to specific development targets (develop, snapshot, or main).

Usage

change_remotes_field(
  path,
  target = c("develop", "snapshot", "main"),
  verbose = TRUE
)

Arguments

path	[character] Path to the package root directory.
target	[character] Target branch or type of remote: must be one of "develop", "snapshot", or "main".
verbose	[logical] Whether to print current and new remote fields (default: TRUE).

Value

Invisibly returns the new vector of remote specifications (character).

Examples

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

change_remotes_field(path = path_rjd3workspace, target = "develop")

---

Check for missing or deprecated documentation tag

Description

check_missing_examples_tag() Identifies exported functions that do not declare any ⁠@examples⁠ (or ⁠@examplesIf⁠) tag in their roxygen2 documentation. check_missing_examples_content() detects exported functions that declare an ⁠@examples⁠ tag but whose examples are not actually present in the combined example blocks. check_missing_title() identifies exported functions that do not define a ⁠@title⁠ tag in their documentation. check_describeIn_usage() lists all documented topics using the ⁠@describeIn⁠ tag. check_return_tag_usage() identifies functions still using ⁠@return⁠. check_missing_returns() identifies exported functions that do not declare a ⁠@returns⁠ tag.

Usage

check_missing_examples_tag(pkg_dir)

check_missing_examples_content(pkg_dir)

check_missing_title(pkg_dir)

check_describeIn_usage(pkg_dir)

check_return_tag_usage(pkg_dir)

check_missing_returns(pkg_dir)

Arguments

pkg_dir

Path to the R package.

Details

The ⁠@describeIn⁠ tag is generally discouraged in modern roxygen2 workflows. The ⁠@return⁠ tag is superseded by ⁠@returns⁠.

Value

A character vector of function names

---

Check R package documentation

Description

Performs a series of documentation consistency checks on a package using roxygen2 parsed blocks.

The following checks are performed:

• Missing ⁠@examples⁠ tag in exported functions

• Missing example content

• Missing ⁠@title⁠

• Usage of discouraged ⁠@describeIn⁠

• Usage of deprecated ⁠@return⁠

• Missing ⁠@returns⁠

Usage

check_docs(pkg_dir = ".", verbose = interactive(), error_on_fail = FALSE)

Arguments

pkg_dir	Path to the R package.
verbose	Logical. If TRUE, prints a formatted summary.
error_on_fail	Logical. If TRUE, stops execution if any issue is found.

Value

An object of class "releaser_doc_check" containing a named list of detected issues.

---

Extract changelog entries for a given version

Description

Extracts the section of NEWS.md corresponding to a given version.

Usage

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

Value

A character string containing the formatted changelog for the given version.

Examples

path_rjd3workspace <- system.file("rjd3workspace", package = "releaser")

get_changes(path = path_rjd3workspace, version_number = "Unreleased")
get_changes(path = path_rjd3workspace, version_number = "3.2.4")
get_changes(path = path_rjd3workspace, version_number = "3.5.1")

---

Compute possible future semantic versions

Description

Given a current package version, compute the potential next patch, minor, and major versions following semantic versioning rules.

Usage

get_different_future_version(version_number, verbose = TRUE)

Arguments

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

Value

A named character vector with:

• current_version – the input version,

• future_patch_version – next patch version,

• future_minor_version – next minor version,

• future_major_version – next major version.

Examples

get_different_future_version("1.2.3")

---

List GitHub repository branches

Description

Retrieve all branch names from a GitHub repository.

Usage

get_github_branches(
  gh_repo = file.path("rjdverse", "rjd3toolkit"),
  verbose = TRUE
)

Arguments

gh_repo	[character] GitHub repository in the format "owner/repo".
verbose	[logical] Whether to print current and new remote fields (default: TRUE).

Value

A character vector with branch names.

Examples

get_github_branches("r-lib/usethis")

---

Get latest GitHub release version

Description

Retrieve the version number of the latest GitHub release for a repository and optionally print versions found across all branches.

Usage

get_latest_version(
  gh_repo = file.path("rjdverse", "rjd3toolkit"),
  verbose = TRUE
)

Arguments

gh_repo	[character] GitHub repository in the format "owner/repo".
verbose	[logical] Whether to print current and new remote fields (default: TRUE).

Value

A character string with the version of the latest release.

Examples

get_latest_version("r-lib/usethis")

---

Set latest versions for ⁠rjd3*⁠ dependencies

Description

Update the DESCRIPTION file of a package so that all dependencies beginning with "rjd3" require the latest released version from GitHub.

Usage

set_latest_deps_version(path, verbose = TRUE)

Arguments

path	[character] Path to the package root directory.
verbose	[logical] Whether to print current and new remote fields (default: TRUE).

Value

Invisibly updates the DESCRIPTION file in place.

Examples

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

set_latest_deps_version(path = path_rjd3workspace)

---

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)

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.

Value

Invisibly returns TRUE if the file was successfully updated.

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

---