|
1 | 1 | #' Increment package version |
2 | 2 | #' |
3 | | -#' @description `use_version()` increments the "Version" field in `DESCRIPTION`, |
4 | | -#' adds a new heading to `NEWS.md` (if it exists), and commits those changes |
5 | | -#' (if package uses Git). It makes the same update to a line like `PKG_version |
6 | | -#' = "x.y.z";` in `src/version.c` (if it exists). |
| 3 | +#' @description |
7 | 4 | #' |
8 | | -#' @description `use_dev_version()` increments to a development version, e.g. |
9 | | -#' from 1.0.0 to 1.0.0.9000. If the existing version is already a development |
10 | | -#' version with four components, it does nothing. Thin wrapper around |
11 | | -#' `use_version()`. |
| 5 | + |
| 6 | +#' usethis supports semantic versioning, which is described in more detail in |
| 7 | +#' the [version |
| 8 | +#' section](https://r-pkgs.org/description.html#description-version) of [R |
| 9 | +#' Packages](https://r-pkgs.org). A version number breaks down like so: |
| 10 | +#' |
| 11 | +#' <major>.<minor>.<patch> (released version) |
| 12 | +#' <major>.<minor>.<patch>.<dev> (dev version) |
| 13 | +#' |
| 14 | + |
| 15 | +#' `use_version()` increments the "Version" field in `DESCRIPTION`, adds a new |
| 16 | +#' heading to `NEWS.md` (if it exists), and commits those changes (if package |
| 17 | +#' uses Git). It makes the same update to a line like `PKG_version = "x.y.z";` |
| 18 | +#' in `src/version.c` (if it exists). |
12 | 19 | #' |
| 20 | + |
| 21 | +#' `use_dev_version()` increments to a development version, e.g. from 1.0.0 to |
| 22 | +#' 1.0.0.9000. If the existing version is already a development version with |
| 23 | +#' four components, it does nothing. Thin wrapper around `use_version()`. |
| 24 | +#' |
| 25 | + |
13 | 26 | #' @param which A string specifying which level to increment, one of: "major", |
14 | 27 | #' "minor", "patch", "dev". If `NULL`, user can choose interactively. |
| 28 | + |
15 | 29 | #' |
16 | 30 | #' @seealso The [version |
17 | | -#' section](https://r-pkgs.org/description.html#version) of [R |
| 31 | +#' section](https://r-pkgs.org/description.html#description-version) of [R |
18 | 32 | #' Packages](https://r-pkgs.org). |
19 | 33 | #' |
20 | 34 | #' @examples |
|
0 commit comments