use_github_release: Publish a GitHub release

In r-lib/usethis: Automate Package and Project Setup

Publish a GitHub release

Description

Pushes the current branch (if safe) then publishes a GitHub release for the latest CRAN submission.

If you use devtools::submit_cran() to submit to CRAN, information about the submitted state is captured in a CRAN-SUBMISSION file. use_github_release() uses this info to populate the GitHub release notes and, after success, deletes the file. In the absence of such a file, we assume that current state (SHA of HEAD, package version, NEWS) is the submitted state.

Usage

use_github_release(
  publish = TRUE,
  host = deprecated(),
  auth_token = deprecated()
)

Arguments

publish	If TRUE, publishes a release. If FALSE, creates a draft release.
host, auth_token	: No longer consulted now that usethis allows the gh package to lookup a token based on a URL determined from the current project's GitHub remotes.

r-lib/usethis documentation built on March 20, 2024, 8:51 p.m.