-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcreate_github_repo.html
More file actions
144 lines (108 loc) · 10.3 KB
/
create_github_repo.html
File metadata and controls
144 lines (108 loc) · 10.3 KB
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
<!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>Create rdev GitHub repository — create_github_repo • 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="Create rdev GitHub repository — create_github_repo"><meta name="description" content="Create, configure, clone, and open a new GitHub R package repository following rdev conventions."><meta property="og:description" content="Create, configure, clone, and open a new GitHub R package repository following rdev conventions."><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>Create rdev GitHub repository</h1>
<small class="dont-index">Source: <a href="https://github.com/jabenninghoff/rdev/blob/HEAD/R/setup.R" class="external-link"><code>R/setup.R</code></a></small>
<div class="d-none name"><code>create_github_repo.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Create, configure, clone, and open a new GitHub R package repository following rdev conventions.</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">create_github_repo</span><span class="op">(</span></span>
<span> <span class="va">repo_name</span>,</span>
<span> repo_desc <span class="op">=</span> <span class="st">""</span>,</span>
<span> private <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> org <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> host <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"rdev.host"</span><span class="op">)</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-repo-name">repo_name<a class="anchor" aria-label="anchor" href="#arg-repo-name"></a></dt>
<dd><p>The name of the GitHub repository to create</p></dd>
<dt id="arg-repo-desc">repo_desc<a class="anchor" aria-label="anchor" href="#arg-repo-desc"></a></dt>
<dd><p>The description of the GitHub repository to create</p></dd>
<dt id="arg-private">private<a class="anchor" aria-label="anchor" href="#arg-private"></a></dt>
<dd><p>If <code>TRUE</code>, creates a private repository.</p></dd>
<dt id="arg-org">org<a class="anchor" aria-label="anchor" href="#arg-org"></a></dt>
<dd><p>The organization to create the repository in. If <code>NULL</code>, create the repository in the
active user's account.</p></dd>
<dt id="arg-host">host<a class="anchor" aria-label="anchor" href="#arg-host"></a></dt>
<dd><p>GitHub host to target, passed to the <code>.api_url</code> argument of
<code><a href="https://gh.r-lib.org/reference/gh.html" class="external-link">gh::gh()</a></code>. If unspecified, gh defaults to "https://api.github.com",
although gh's default can be customised by setting the GITHUB_API_URL
environment variable.</p>
<p>For a hypothetical GitHub Enterprise instance, either
"https://github.acme.com/api/v3" or "https://github.acme.com" is
acceptable.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>return value from <code><a href="https://gh.r-lib.org/reference/gh.html" class="external-link">gh::gh()</a></code> creating the repository, invisibly</p>
</div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
<p>When run, <code>create_github_repo()</code>:</p><ol><li><p>Creates a new GitHub repository using <code><a href="https://gh.r-lib.org/reference/gh.html" class="external-link">gh::gh()</a></code> with license template from <code><a href="get_license.html">get_license()</a></code></p></li>
<li><p>Activates Dependabot alerts per <code>getOption("rdev.dependabot", default = TRUE)</code></p></li>
<li><p>Activates Dependabot security updates per <code>getOption("rdev.dependabot", default = TRUE)</code></p></li>
<li><p>Adds branch protection to the default branch (if <code>private</code> is <code>FALSE</code>)</p></li>
<li><p>Clones the repository locally with <code><a href="https://usethis.r-lib.org/reference/create_from_github.html" class="external-link">usethis::create_from_github()</a></code></p></li>
<li><p>Creates a basic package using <code><a href="https://usethis.r-lib.org/reference/create_package.html" class="external-link">usethis::create_package()</a></code></p></li>
<li><p>If running interactively, the repository will automatically be opened in RStudio, GitHub
Desktop, and the default browser</p></li>
</ol></div>
<div class="section level2">
<h2 id="github-actions">GitHub Actions<a class="anchor" aria-label="anchor" href="#github-actions"></a></h2>
<p>GitHub Actions can be disabled by setting <code>rdev.github.actions</code> to
<code>FALSE</code>: <code>options(rdev.github.actions = FALSE)</code></p>
</div>
<div class="section level2">
<h2 id="host">Host<a class="anchor" aria-label="anchor" href="#host"></a></h2>
<p>Set the <code>rdev.host</code> option when using a GitHub Enterprise server:
<code>options(rdev.host = "https://github.example.com/api/v3")</code></p>
</div>
<div class="section level2">
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
<div class="dont-index"><p><a href="quickstart.html">quickstart</a></p></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>