release_gh {precommit} | R Documentation |
Create a new release on GitHub
Description
This must be done before a CRAN release.
Usage
release_gh(bump = "dev", is_cran = bump != "dev")
Arguments
bump |
The bump increment, either "dev", "patch", "minor" or "major". |
is_cran |
Is this release a CRAN release? |
Details
This function does the following:
bump description.
update default config in inst/
commit
git tag
run
inst/hooks/local/consistent-release-tag.R
hook with –release-mode (passing args to hooks not possible interactively, hence we run in advance).commit and push with skipping
inst/hooks/local/consistent-release-tag.R
.autoupdate own config file
bump description with dev
commit and push DESCRIPTION and .pre-commit-config.yaml
CRAN release
If is_cran
is TRUE
, the workflow is changed slightly:
push to release branch, not main.
doesn't run
release_complete()
. This must be done manually after accepted on CRAN.
[Package precommit version 0.4.3 Index]