Skip to content

Releasing kbtbr

Frie edited this page Feb 8, 2022 · 3 revisions

Once we have a significant increment on dev, we might want to release a new version to main (and eventually to CRAN).

Proceed as follows:

  1. increase the package version in DESCRIPTION on dev using semantic versioning ( see here). This means (most of the time):
  • bug fixes increase the patch version (e.g. 0.1.0 --> 0.1.1)
  • new (backwards-compatible) features increase the minor version (e.g. 0.1.1 --> 0.2.0)
  • new (backwards-incompatible) changes increase the major version (e.g. 0.2.0 --> 1.0.0)
  1. add information about the new features/bug fixes to NEWS.md (see here and here. The news of the newest version should be at the top.
  2. squash merge into main.
  3. on the main branch:
  • create a (lightweigt) git tag named as the version with a leading v, e.g. v0.1.2. You can do this using the command line interface.
  • create a release (using the gh CLI or in the browser)
  1. back on dev, increase the version in DESCRIPTION with a patch number once we have an increment compared to the released version, e.g. change 0.1.2 to 0.1.2.9000 to indicate that this is the development version of kbtbr.