use_github_release: Publish a GitHub release
In usethis: Automate Package and Project Setup
use_github_release R Documentation
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)
Arguments
publish
If TRUE, publishes a release. If FALSE, creates a draft
release.
usethis documentation built on Sept. 9, 2025, 5:25 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| use_github_release | R Documentation |
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)
Arguments
publish |
If |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.