pb_new_release: Create a new release on GitHub repo

Description Usage Arguments Examples

View source: R/pb_new_release.R

Description

Create a new release on GitHub repo

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
pb_new_release(
  repo = guess_repo(),
  tag,
  commit = "master",
  name = tag,
  body = "Data release",
  draft = FALSE,
  prerelease = FALSE,
  .token = get_token()
)

Arguments

repo

Repository name in format "owner/repo". Will guess the current repo if not specified.

tag

tag to create for this release

commit

Specifies the commit-ish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the git tag already exists. Default: the repository's default branch (usually master).

name

The name of the release. Defaults to tag.

body

Text describing the contents of the tag. default text is "Data release".

draft

default FALSE. Set to TRUE to create a draft (unpublished) release.

prerelease

default FALSE. Set to TRUE to identify the release as a pre-release.

.token

GitHub authentication token. Typically set from an environmental variable, e.g. in a .Renviron file or with Sys.setenv(GITHUB_TOKEN = "xxxxx"), which helps prevent accidental disclosure of a secret token when sharing scripts.

Examples

1
2
3
4
## Not run: 
pb_new_release("cboettig/piggyback-tests", "v0.0.5")

## End(Not run)

piggyback documentation built on Feb. 25, 2020, 5:08 p.m.