bump_version: Bump package version

In fledge: Smoother Change Tracking and Versioning for R Packages

Bump package version

Description

Calls the following functions:

1. Verify that the current branch is the main branch.

2. update_news()

3. update_version(), using the which argument

4. Depending on the which argument:

   • If "dev", finalize_version() with push = FALSE

   • Otherwise, commit_version().

Usage

bump_version(which = "dev")

Arguments

which

Component of the version number to update. Supported values are "dev" (default), "patch", "minor" and "major".

Value

None

Bumped too soon?

Have you just run bump_version(), then realized "oh shoot, I forgot to merge that PR"? Fear not, run unbump_version(), merge that PR, run bump_version().

See Also

unbump_version()

Examples

# Create mock package in a temporary directory.
# Set open to TRUE if you want to play in the mock package.
with_demo_project({
  # Use functions as if inside the newly created package project.
  # (Or go and actually run code inside the newly created package project!)
  # Add a new R file.
  usethis::use_r("cool-function", open = FALSE)
  # Pretend we added useful code inside it.
  # Track the new R file with Git.
  gert::git_add("R/cool-function.R")
  gert::git_commit("- Add cool function.")
  # Bump version with fledge.
  fledge::bump_version()
})

fledge documentation built on May 29, 2024, 8:59 a.m.