use_git_hook_precommit: Use grkmisc git Pre-Commit Hook

In GerkeLab/grkmisc: A package of miscellaneously helpful functions

Description

Installs a pre-commit hook that automatically bumps the lowest part of the package version before committing - for example from 0.1.2.9000 to 0.1.2.90001 - and tidies up the DESCRIPTION file using usethis::use_tidy_description. If the version was manually changed as part of the commit, the version number is not changed. If changes were made to the DESCRIPTION file but this file was not committed, those additional changes will be committed with the version bump.

Usage

use_git_hook_precommit()

Disabling the hook

You can disable the pre-commit hook in two ways. First you can set an environment variable when committing your files: doIncrement=FALSE git commit -m "commit message". Alternatively, you can skip the pre-commit hook with git commit --no-verify -m "commit message".

GerkeLab/grkmisc documentation built on Feb. 23, 2020, 6:50 a.m.