File: submit_cran.Rd

package info (click to toggle)
r-cran-xfun 0.37%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 792 kB
  • sloc: ansic: 242; sh: 22; makefile: 2
file content (28 lines) | stat: -rw-r--r-- 1,052 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
24
25
26
27
28
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cran.R
\name{submit_cran}
\alias{submit_cran}
\title{Submit a source package to CRAN}
\usage{
submit_cran(file = pkg_build(), comment = "")
}
\arguments{
\item{file}{The path to the source package tarball. By default, the current
working directory is treated as the package root directory, and
automatically built into a tarball, which is deleted after submission. This
means you should run \code{xfun::submit_cran()} in the root directory of a
package project, unless you want to pass a path explicitly to the
\code{file} argument.}

\item{comment}{Submission comments for CRAN. By default, if a file
\file{cran-comments.md} exists, its content will be read and used as the
comment.}
}
\description{
Build a source package and submit it to CRAN with the \pkg{curl} package.
}
\seealso{
\code{devtools::submit_cran()} does the same job, with a few more
  dependencies in addition to \pkg{curl} (such as \pkg{cli});
  \code{xfun::submit_cran()} only depends on \pkg{curl}.
}