rdev/docs/reference/ci.html at c3f7ff4cbdec592a8b4fef37ebb0d4ae3950b4ed · jabenninghoff/rdev · GitHub

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en-US"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Local CI — ci • rdev</title><!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png"><link rel="icon" type="”image/svg+xml”" href="../favicon.svg"><link rel="apple-touch-icon" sizes="180x180" href="../apple-touch-icon.png"><link rel="icon" sizes="any" href="../favicon.ico"><link rel="manifest" href="../site.webmanifest"><script src="../lightswitch.js"></script><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Local CI — ci"><meta name="description" content="Run continuous integration tests locally."><meta property="og:description" content="Run continuous integration tests locally."><meta property="og:image" content="https://jabenninghoff.github.io/rdev/logo.png"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top " aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">rdev</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.15.6</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/rdev.html">Get started</a></li>
<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/analysis-package-layout.html">Analysis Package Layout</a></li>
    <li><a class="dropdown-item" href="../articles/style-guide.html">Style Guide</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jabenninghoff/rdev/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-lightswitch" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true" aria-label="Light switch"><span class="fa fa-sun"></span></button>
  <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="dropdown-lightswitch"><li><button class="dropdown-item" data-bs-theme-value="light"><span class="fa fa-sun"></span> Light</button></li>
    <li><button class="dropdown-item" data-bs-theme-value="dark"><span class="fa fa-moon"></span> Dark</button></li>
    <li><button class="dropdown-item" data-bs-theme-value="auto"><span class="fa fa-adjust"></span> Auto</button></li>
  </ul></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.png" class="logo" alt=""><h1>Local CI</h1>
      <small class="dont-index">Source: <a href="https://github.com/jabenninghoff/rdev/blob/HEAD/R/ci.R" class="external-link"><code>R/ci.R</code></a></small>
      <div class="d-none name"><code>ci.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Run continuous integration tests locally.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ci</span><span class="op">(</span></span>
<span>  renv <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  missing <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  pkgdown <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  styler <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  lintr <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  document <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  normalize <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  extra <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  spelling <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  urls <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  rcmdcheck <span class="op">=</span> <span class="cn">TRUE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-renv">renv<a class="anchor" aria-label="anchor" href="#arg-renv"></a></dt>
<dd><p>check <code><a href="https://rstudio.github.io/renv/reference/status.html" class="external-link">renv::status(dev = TRUE)</a></code></p></dd>


<dt id="arg-missing">missing<a class="anchor" aria-label="anchor" href="#arg-missing"></a></dt>
<dd><p>run <code><a href="deps_check.html">missing_deps()</a></code></p></dd>


<dt id="arg-pkgdown">pkgdown<a class="anchor" aria-label="anchor" href="#arg-pkgdown"></a></dt>
<dd><p>check <code><a href="https://pkgdown.r-lib.org/reference/check_pkgdown.html" class="external-link">pkgdown::check_pkgdown()</a></code> if <code>_pkgdown.yml</code> exists</p></dd>


<dt id="arg-styler">styler<a class="anchor" aria-label="anchor" href="#arg-styler"></a></dt>
<dd><p>style all files using <code><a href="style_all.html">style_all()</a></code>, see details</p></dd>


<dt id="arg-lintr">lintr<a class="anchor" aria-label="anchor" href="#arg-lintr"></a></dt>
<dd><p>lint all files using <code><a href="lint_all.html">lint_all()</a></code></p></dd>


<dt id="arg-document">document<a class="anchor" aria-label="anchor" href="#arg-document"></a></dt>
<dd><p>run <code><a href="https://devtools.r-lib.org/reference/document.html" class="external-link">devtools::document()</a></code></p></dd>


<dt id="arg-normalize">normalize<a class="anchor" aria-label="anchor" href="#arg-normalize"></a></dt>
<dd><p>run <code><a href="https://desc.r-lib.org/reference/desc_normalize.html" class="external-link">desc::desc_normalize()</a></code></p></dd>


<dt id="arg-extra">extra<a class="anchor" aria-label="anchor" href="#arg-extra"></a></dt>
<dd><p>run <code><a href="deps_check.html">extra_deps()</a></code></p></dd>


<dt id="arg-spelling">spelling<a class="anchor" aria-label="anchor" href="#arg-spelling"></a></dt>
<dd><p>update spelling <code><a href="https://docs.ropensci.org/spelling//reference/wordlist.html" class="external-link">WORDLIST</a></code></p></dd>


<dt id="arg-urls">urls<a class="anchor" aria-label="anchor" href="#arg-urls"></a></dt>
<dd><p>validate URLs with <code><a href="urlchecker-reexports.html">url_check()</a></code> and <code><a href="html_url_check.html">html_url_check()</a></code></p></dd>


<dt id="arg-rcmdcheck">rcmdcheck<a class="anchor" aria-label="anchor" href="#arg-rcmdcheck"></a></dt>
<dd><p>run <code>R CMD check</code> using:
<code><a href="http://r-lib.github.io/rcmdcheck/reference/rcmdcheck.html" class="external-link">rcmdcheck::rcmdcheck(args = "–no-manual", error_on = "warning")</a></code></p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>If <code><a href="https://rstudio.github.io/renv/reference/status.html" class="external-link">renv::status(dev = TRUE)</a></code> is not synchronized, <code>ci()</code> will stop.</p>
<p>If <code><a href="deps_check.html">missing_deps()</a></code> returns any missing dependencies, <code>ci()</code> will stop.</p>
<p><code><a href="https://pkgdown.r-lib.org/reference/check_pkgdown.html" class="external-link">pkgdown::check_pkgdown()</a></code> will halt <code>ci()</code> with an error if <code>_pkgdown.yml</code> is invalid.</p>
<p>If <code>styler</code> is set to <code>NULL</code> (the default), <code><a href="style_all.html">style_all()</a></code> will be run only if there are no
uncommitted changes to git. Setting the value to <code>TRUE</code> or <code>FALSE</code> overrides this check.</p>
<p>If <code><a href="lint_all.html">lint_all()</a></code> finds any lints, <code>ci()</code> will stop and open the RStudio markers pane.</p>
<p>Output from <code>missing</code>, <code>extra</code>, and <code>urls</code> is printed as a <a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a> for
improved readability in the console.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span></span>
<span class="r-in"><span><span class="fu">ci</span><span class="op">(</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">ci</span><span class="op">(</span>styler <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu">ci</span><span class="op">(</span>styler <span class="op">=</span> <span class="cn">FALSE</span>, rcmdcheck <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="op">}</span> <span class="co"># }</span></span></span>
</code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by John Benninghoff.</p>
</div>

<div class="pkgdown-footer-right">
  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.2.0.</p>
</div>

    </footer></div>


  </body></html>