You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*`use_data()` gains a `version` argument and defaults to serialization format
6
-
version 2 (#675).
7
-
8
-
*`use_data_raw()` accepts a name for the to-be-prepared dataset and opens a
9
-
templated R script (#646).
10
-
11
-
*`git_remotes()` and `use_git_remote()` are new helpers to inspect or modify
12
-
Git remote URLs for the repo associated with the active project (#649).
13
-
14
-
*`use_rcpp_armadillo()` and `use_rcpp_eigen()` are new functions
15
-
that set up a package to use RcppArmadillo or RcppEigen, respectively
16
-
(#421, @coatless, @duckmayr).
17
-
18
-
*`use_tutorial()` creates a new interactive R Markdown tutorial, as implemented
19
-
by the [`learnr` package](https://rstudio.github.io/learnr/index.html)
20
-
(@angela-li, #645).
5
+
usethis gains several functions to inspect and manipulate the Git situation for the current project = repository. We also provide more control and visibility
6
+
into git2r's workings, especially around credentials (usethis uses git2r for all
7
+
Git operations).
21
8
22
-
*`use_ccby_license()` adds a CCBY 4.0 license (#547, @njtierney)
23
-
24
-
*`git_protocol()` + `use_git_protocol()` and `git_credentials()` + `use_git_credentials()` are new helpers to summon or set git transport protocol (SSH or HTTPS) or git2r credentials, respectively. These functions are primarily for internal use. Most users can rely on default behaviour, but these helpers can be used to intervene if git2r isn't discovering the right credentials (#653).
25
-
26
-
*`use_github()` tries harder but also fails earlier, with more informative messages, making it less likely to leave the repo partially configured (#221).
27
-
28
-
*`git_sitrep()` lets you know what's up with your git, git2r and GitHub
9
+
*`git_sitrep()` lets you know what's up with your Git, git2r and GitHub
29
10
config (#328).
30
11
31
-
*`git_vaccinate()` vaccinates your global git ignore file ensuring that
32
-
you never check in files likely to contain confidential information (#469).
33
-
It is called automatically if `use_git_ignore()` creates a new `.gitnore`
34
-
file.
35
-
36
-
*`pr_init()`, `pr_fetch()`, `pr_push()`, `pr_pull()`, and `pr_finish()` are a
37
-
new family of helpers designed to help with the GitHub PR process. Currently
38
-
they assume that you're working on your own repo (i.e. no fork), but once
39
-
we've happy with them, we'll extend to work on more situations (#346).
40
-
41
-
* New `proj_activate()` lets you activate a project either opening a new
42
-
RStudio session (if you use RStudio), or changing the working directory
43
-
(#511).
44
-
45
-
*`use_article()` creates articles, vignettes that are automatically
46
-
added to `.Rbuildignore`. These appear on pkgdown sites, but are not
47
-
included with the package itself (#281).
48
-
49
-
*`use_citation()` creates a basic `CITATION` template and puts it in the
50
-
right place (#100).
51
-
52
-
*`use_c("foo")` sets up `src/` and creates `src/foo.c` (#117).
12
+
*`git_vaccinate()` vaccinates your global (i.e. user-level) git ignore file.
13
+
It adds standard entries for R users, such as `.Rhistory` and `.Rdata`. This
14
+
decreases the chance that you commit and push files containing confidential
15
+
information (#469).
53
16
54
-
*`use_devtools()`(#624), `use_conflicted()`(#362), and `use_reprex()` (#465)
55
-
help add useful packages to your `.Rprofile`.
17
+
*`git_remotes()`and `use_git_remote()`are new helpers to inspect or modify
18
+
Git remote URLs for the repo associated with the active project (#649).
56
19
57
-
*`use_covr_ignore()` makes it easy to ignore files in test coverage (#434).
58
-
59
-
*`use_github_release()` creates a draft GitHub release using the entries
60
-
in `NEWS.md` (#137).
61
-
62
-
*`use_gitlab_ci()` creates a draft gitlab-ci.yaml for use with GitLab
63
-
(#565, @overmar).
20
+
*`git_protocol()` + `use_git_protocol()` and `git_credentials()` +
21
+
`use_git_credentials()` are new helpers to summon or set Git transport
22
+
protocol (SSH or HTTPS) or git2r credentials, respectively. These functions
23
+
are primarily for internal use. Most users can rely on default behaviour. Use
24
+
these helpers to intervene if git2r isn't discovering the right credentials
25
+
(#653). usethis honors the `usethis.protocol` option, which allows you to
26
+
express a general preference for SSH vs. HTTPS.
27
+
28
+
Other improvements and bug fixes:
29
+
30
+
*`use_github()` tries harder but also fails earlier, with more informative
31
+
messages, making it less likely to leave the repo partially configured (#221).
32
+
33
+
*`use_github()` and `create_from_github()` gain a `protocol` argument
34
+
(#494, @cderv).
35
+
36
+
*`create_from_github()` pulls from upstream master in a fork (#695, @ijlyttle).
64
37
65
-
*`use_lgpl_license()` automates set up of the LGL license (#448, @krlmlr).
38
+
*`use_release_issue()` creates a GitHub issue containing a release checklist,
39
+
reflecting the standard practices of the tidyverse team (#338).
66
40
67
-
*`use_partial_warnings()`helps use add standard warning block to your
68
-
`.Rprofile` (#64).
41
+
*`use_github_release()`creates a draft GitHub release using the entries in
42
+
`NEWS.md` (#137).
69
43
70
-
*`use_pkgdown_travis()`helps you set up pkgdown for automatic deployment
71
-
from travis to github pages (#524).
44
+
*`use_gitlab_ci()`creates a `gitlab-ci.yaml` config file for GitLab CI
45
+
(#565, @overmar).
72
46
73
-
*`use_rcpp("foo")` now creates `src/foo.cpp` (#117).
47
+
*`use_git_config()` now invisibly returns the previous values of the
48
+
settings.
74
49
75
-
*`use_release_issue()` creates a GitHub issue containing a release checklist
76
-
capturing best practices discovered by the tidyverse team (#338)
50
+
*`use_github_labels()` has been rewritten be more flexible. You can now supply
51
+
a repo name, and `descriptions`, and you can set colours/descriptions
52
+
independently of creating labels. You can also `rename` existing labels
53
+
(#290).
77
54
78
-
*`write_union` appends the novel `lines`, but does not remove duplicates from
79
-
existing lines (#583, @khailper).
55
+
## GitHub pull requests
80
56
81
-
* New `use_addin()` helps setup necessary binding information for RStudio
82
-
addins. (#353, @haozhu233)
57
+
We've added **experimental** functions to work with GitHub pull requests. They
58
+
are aimed at both a maintainer (who may make, review, and modify pull
59
+
requests) and a contributor (who may make or explore pull requests).
83
60
61
+
*`git_sitrep()` includes a section at the end aimed at describing "pull request
62
+
readiness". Expect that to develop and expand.
63
+
64
+
*`pr_init()`, `pr_fetch()`, `pr_push()`, `pr_pull()`, `pr_finish()`, and
65
+
`pr_view()` constitute the new family of helpers. They are designed to be
66
+
smart about the significance of remotes with the standard names of `origin`
67
+
and `upstream` and to facilitate both internal and external pull requests.
84
68
85
69
## Partial file management
86
70
87
-
usethis gains tooling to manage part of a file. This currently used for managing badges in your README, and roxygen import tags:
71
+
usethis gains tooling to manage part of a file. This is currently used for
72
+
managing badges in your README and roxygen import tags:
88
73
89
74
*`use_badge()` and friends now automatically add badges if your README
90
75
contains a specially formatted badge block (#497):
@@ -94,7 +79,7 @@ usethis gains tooling to manage part of a file. This currently used for managing
94
79
<-- badge:end -->
95
80
```
96
81
97
-
* `use_tibble()` and `use_rcpp()` automatically adding roxygen tags to
82
+
* `use_tibble()` and `use_rcpp()` automatically add roxygen tags to
98
83
to `{package}-package.R` if it contains a specially formatted namespace
99
84
block (#517):
100
85
@@ -110,12 +95,17 @@ usethis gains tooling to manage part of a file. This currently used for managing
110
95
111
96
## Extending and wrapping usethis
112
97
98
+
* New `proj_activate()` lets you activate a project, either opening a new
99
+
RStudio session (if you use RStudio) or changing the working directory
100
+
(#511).
101
+
113
102
* `proj_get()` and `proj_set()` no longer have a `quiet` argument. The
114
103
user-facing message about setting a project is now under the same control
115
104
as other messages, i.e. `getOption("usethis.quiet", default = FALSE)` (#441).
116
105
117
-
* A new family of `ui_` functions makes it possible to make use of the
118
-
user interface of usethis in your own code (#308). There are four families
106
+
* A new set of `ui_*()` functions makes it possible to give your own code
107
+
the same user interface as usethis (#308). All use the glue and crayon and
108
+
packages to power easy interpolation and formatting. There are four families
0 commit comments