Skip to contents

Create a GitHub Release

Source: R/github-release.R
dot-GithubRelease.Rd

Wrapper for usethis::use_github_release().

Usage

.GithubRelease(publish = NULL, prerelease = NULL)

Arguments

publish, prerelease

Whether this release should be published and if it should be tagged as a prerelease. When missing() will prompt during an interactive() session, otherwise defaults to FALSE

Details

When prerelease is TRUE, a facsimile of usethis::use_github_release() is employed to create a prerelease. This assumes ...

  • the package is hosted on GitHub

  • the remote is named origin

  • the branch is named main

  • the package has a DESCRIPTION file which contains an appropriate Package name and Version

  • you want to use the generate_release_notes feature of the GitHub API