1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/release.R
\name{use_release_issue}
\alias{use_release_issue}
\title{Create a release checklist in a GitHub issue}
\usage{
use_release_issue(version = NULL)
}
\arguments{
\item{version}{Optional version number for release. If unspecified, you can
make an interactive choice.}
}
\description{
When preparing to release a package to CRAN there are quite a few steps that
need to be performed, and some of the steps can take multiple hours. This
function creates a checklist in a GitHub issue to:
\itemize{
\item Help you keep track of where you are in the process
\item Feel a sense of satisfaction as you progress towards final submission
\item Help watchers of your package stay informed.
}
The checklist contains a generic set of steps that we've found to be helpful,
based on the type of release ("patch", "minor", or "major"). You're
encouraged to edit the issue to customize this list to meet your needs.
\subsection{Customization}{
\itemize{
\item If you want to consistently add extra bullets for every release, you can
include your own custom bullets by providing an (unexported)
\code{release_bullets()} function that returns a character vector.
(For historical reasons, \code{release_questions()} is also supported).
\item If you want to check additional packages in the revdep check process,
provide an (unexported) \code{release_extra_revdeps()} function that
returns a character vector. This is currently only supported for
Posit internal check tooling.
}
}
}
\examples{
\dontrun{
use_release_issue("2.0.0")
}
}
|
