dpkg_gh_release {dpkg} | R Documentation |
Use a dpkg to create a github release
Description
The release will be tagged at the current commit and
named according to the name
and version
of the dpkg.
The GITHUB_PAT
environment variable must be set and the working directory
must be inside of a git repository with a GitHub remote.
Trying to create more than one release from the current commit will result in an error.
Usage
dpkg_gh_release(x, draft = TRUE, generate_release_notes = FALSE)
Arguments
x |
a data package ( |
draft |
logical; mark release as draft? |
generate_release_notes |
logical; include GitHub's auto-generated release notes below the description in the release body? |
Value
the URL to the release (invisibly)
Examples
## Not run:
dpkg_gh_release(
as_dpkg(mtcars,
version = "0.0.0.9000", title = "Foofy Cars",
homepage = "https://github.com/cole-brokamp/dpkg",
description =
paste("# Foofy Cars\n",
"This is a test for the [dpkg](https://github.com/cole-brokamp/dpkg) package.",
collapse = "\n"
)
),
draft = FALSE
)
## End(Not run)
#> created release at: https://github.com/cole-brokamp/dpkg/releases/tag/mtcars-v0.0.0.9000
[Package dpkg version 0.6.0 Index]