File: use_github_release.Rd

package info (click to toggle)
r-cran-usethis 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,228 kB
  • sloc: sh: 26; makefile: 17; cpp: 6; ansic: 3
file content (23 lines) | stat: -rw-r--r-- 865 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/release.R
\name{use_github_release}
\alias{use_github_release}
\title{Publish a GitHub release}
\usage{
use_github_release(publish = TRUE)
}
\arguments{
\item{publish}{If \code{TRUE}, publishes a release. If \code{FALSE}, creates a draft
release.}
}
\description{
Pushes the current branch (if safe) then publishes a GitHub release for the
latest CRAN submission.

If you use \code{\link[devtools:submit_cran]{devtools::submit_cran()}} to submit to CRAN, information about the
submitted state is captured in a \code{CRAN-SUBMISSION} file.
\code{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 \code{HEAD}, package version, NEWS) is the
submitted state.
}