bumpVersion: Bump Package 'Version:' and 'Date:' in DESCRIPTION File

In fdetsch/Orcs: Omnidirectional R Code Snippets

Bump Package 'Version:' and 'Date:' in DESCRIPTION File

Description

This function let's you bump the version number and creation date of your package's DESCRIPTION file. Additionally, it bumps the version numbers of a NEWS.md file and automatically generates a corresponding plain NEWS file (for R-help pages). Supported versioning system is MAJOR.MINOR.PATCH.

Usage

bumpVersion(
  element = "patch",
  pkg.repo = ".",
  news = file.path(pkg.repo, "NEWS.md"),
  plain_news = TRUE
)

Arguments

element	character, one of "major", "minor", "patch" (default) to be bumped.
pkg.repo	Path to package repository folder. Default is current working directory, i.e. ".".
news	The NEWS.md file of the repo (assumed to be in top level path). If this exists, the first line of that file will be rewritten to be "\<packagename\> \<major.minor.patch\>". Note that the current implementation assumes that the NEWS file is in .md format. A plain NEWS file (for R-help pages) will be generated automatically.
plain_news	whether to generate a plain NEWS file in the package root directory from the NEWS.md file supplied to argument 'news'.

Author(s)

Tim Appelhans

See Also

https://semver.org/

fdetsch/Orcs documentation built on Jan. 9, 2023, 6:14 a.m.