|
1 | 1 | # usethis (development version) |
2 | 2 |
|
3 | | -* `use_github_links()` by default now appends the GitHub url to existing urls in |
4 | | - in the `URL` field of DESCRIPTION, rather than replacing existing urls (#1805). |
| 3 | +## New functions |
| 4 | + |
| 5 | +* `use_author()` is a new function to introduce a new person into the |
| 6 | + `Authors@R` field of DESCRIPTION (@avalcarcel9, #833). |
5 | 7 |
|
| 8 | +* `use_rstudio_preferences()` lets you set RStudio preferences programmatically |
| 9 | + (#1518) |
| 10 | + |
| 11 | +* `use_standalone()` is a new function that makes it easier to use standalone |
| 12 | + files provided by various low-level tidyverse packages, like rlang (#1654). |
| 13 | + |
6 | 14 | * `use_upkeep_issue()` is a new function to facilitate regular maintenance of |
7 | 15 | your package. Similar to `use_release_issue()`, it opens an issue in your repo |
8 | 16 | with a checklist of maintenance tasks. It will include additional bullets |
9 | 17 | if your package includes an `upkeep_bullets()` function that returns a |
10 | | - character vector. |
| 18 | + character vector (#1794). |
11 | 19 |
|
| 20 | +## Package development |
| 21 | + |
| 22 | +* Although nested projects are discouraged, they can be useful in development |
| 23 | + contexts. `create_package()` now sets the correct package name and returns |
| 24 | + the correct package path for a package nested inside a project (#1647). |
| 25 | + |
| 26 | +* `use_article()` no longer adds the rmarkdown package to `Suggests`. Instead, |
| 27 | + if rmarkdown is not already a dependency, it's added to |
| 28 | + `Config/Needs/website`. This means that a package that only uses articles |
| 29 | + (vs. vignettes) won't gain an unnecessary dependency on rmarkdown (#1700). |
| 30 | + |
| 31 | +* `use_data()` now sets the appropriate minimal R version in `DESCRIPTION`, |
| 32 | + depending on which serialization format `version` you choose (@dpprdan, #1672). |
| 33 | + |
| 34 | +* `use_github_links()` by default now appends the GitHub url to existing urls in |
| 35 | + in the `URL` field of DESCRIPTION, rather than replacing existing urls (#1805). |
| 36 | + |
| 37 | +* `use_latest_dependencies()` no longer affects `Suggests` since those |
| 38 | + dependencies are not enforced (#1749). |
| 39 | + |
12 | 40 | * `use_news_md()` now places "(development version)" in the header of `NEWS.md` |
13 | 41 | if there is a development version number in `DESCRIPTION`. It also sets the |
14 | 42 | first bullet to "Initial CRAN submission" when it looks like a "new" package |
15 | 43 | (#1708). |
16 | 44 |
|
17 | | -* `use_rscloud_badge()` has been deprecated in favour of |
18 | | - `use_posit_cloud_badge()`, and both functions now accept the updated url |
19 | | - format of Posit Cloud projects (#1670). |
20 | | - |
21 | | -* `use_author()` is a new function to introduce a new person into the |
22 | | - `Authors@R` field of DESCRIPTION (@avalcarcel9, #833). |
23 | | - |
24 | | -* Links to the R Packages book have been updated to the second edition of |
25 | | - the book (#1689). |
| 45 | +## Package release |
26 | 46 |
|
27 | 47 | * `use_release_issue()` will now remind you to run `use_github_links()` if |
28 | 48 | necessary (@Bisaloo, #1754) |
29 | 49 |
|
30 | | -* `use_version()` and `use_dev_version()` gain a `push` argument to optionally |
31 | | - push the result after committing. This is used to eliminate a manual step from |
32 | | - the `use_release_issue()` checklist (#1385). |
33 | | - |
34 | | -* `use_github_release()` now automatically pushes to GitHub (if safe) (#1385) |
35 | | - and automatically publishes the release, rather than requiring you to edit |
36 | | - and publish the draft. |
37 | | - |
38 | | -* `use_tidy_logo()` is a new function that calls `use_logo()` on the appropriate |
39 | | - hex sticker PNG file at <https://github.com/rstudio/hex-stickers> (@ateucher, |
40 | | - #1871). |
41 | | - |
42 | | -* `use_github_release()` no longer fails in the absence of `NEWS.md` (#1755). |
43 | | - |
44 | 50 | * `use_release_issue()` now encourages the creation of `NEWS.md` prior to |
45 | 51 | submission, instead of after (#1755). |
| 52 | + |
| 53 | +* `use_github_release()` now automatically pushes to GitHub (if safe) and |
| 54 | + automatically publishes the release, rather than requiring you to edit and |
| 55 | + publish the draft (#1385). |
46 | 56 |
|
| 57 | +* `use_github_release()` no longer fails in the absence of `NEWS.md` (#1755). |
| 58 | + |
| 59 | +* `use_release_issue()` will now remind you to check/close the milestone |
| 60 | + corresponding to the release, if it exists (#1642). |
| 61 | + |
| 62 | +* `use_version()` and `use_dev_version()` gain a `push` argument to optionally |
| 63 | + push the result after committing. This is used to eliminate a manual step from |
| 64 | + the `use_release_issue()` checklist (#1385). |
| 65 | + |
47 | 66 | * `use_revdep()` no longer places an email template, because these days we are |
48 | 67 | more likely to communicate with other maintainers about breaking changes via |
49 | 68 | GitHub issues and pull requests (#1769). |
50 | 69 |
|
51 | | -* `use_rstudio_preferences()` lets you set RStudio preferences programmatically |
52 | | - (#1518) |
53 | | - |
54 | | -* `write_over()` and `use_github_file()` gain an overwrite argument (#1748). |
| 70 | +## Package file management |
55 | 71 |
|
56 | | -* `use_standalone()` makes it easier to use standalone files provided by |
57 | | - various low-level tidyverse packages, like rlang (#1654). |
| 72 | +* `rename_files()` now also affects files in `src/` (#1585). |
58 | 73 |
|
59 | | -* `use_latest_dependencies()` no longer affects `Suggests` since those |
60 | | - dependencies are not enforced (#1749). |
| 74 | +* `use_r()` and `use_test()` now work with all active files in `R/`, `src/`, |
| 75 | + and `tests/testthat/` (#1566). |
61 | 76 |
|
62 | | -* `use_release_issue()` will now remind you to check/close the milestone |
63 | | - corresponding to the release, if it exists (#1642). |
| 77 | +* `use_r()` and `use_test()` now work with files containing `.` (#1690). |
64 | 78 |
|
65 | | -* `use_release_issue()` now uses internal `release_extra_revdeps()` to |
66 | | - add extra revdep sources. Currently only use for internal Posit tooling, |
67 | | - but we hope to extend to all users in the future (#1610). |
| 79 | +* `use_rcpp()`, `use_c()` and friends now work the same way as `use_r()` and |
| 80 | + `use_test()`: they'll take the default file name from the file you currently |
| 81 | + have open in RStudio (#1730). |
| 82 | + |
| 83 | +## Git and GitHub |
68 | 84 |
|
69 | 85 | * `create_from_github()` will now use an existing `.Rproj` file if it exists |
70 | 86 | anywhere in the repo, not just the root directory. This is useful if you're |
71 | 87 | working with repos that contain tools for multiple languages (#1680). |
72 | 88 |
|
73 | | -* `use_travis()` and `use_appveyor()` are now defunct because we no longer |
74 | | - recommend Travis or Appveyor. We recommend GitHub actions instead (#1517). |
| 89 | +* `git_sitrep()` gains two arguments: `tool` and `scope`, which enables |
| 90 | + you to limit the report to, for example, `tool = "git"` or `scope = "user"`. |
| 91 | + The default remains to provide a full report. Also, provides more |
| 92 | + feedback if git user's information is not set, and checks global git-email |
| 93 | + against user-level GitHub PAT (@ijlyttle, #1732, #1714, #1706). |
| 94 | + |
| 95 | +* `git_vaccinated()` now treats a path configured as `core.excludesFile` like |
| 96 | + other user-supplied paths; in particular, any use of the `~/` home directory |
| 97 | + shortcut is expanded via |
| 98 | + [`fs::path_expand()`](https://fs.r-lib.org/reference/path_expand.html) |
| 99 | + (@dpprdan, #1560). |
75 | 100 |
|
76 | 101 | * `use_github_action()` now suggests possible actions when called without |
77 | 102 | arguments (#1724). |
|
81 | 106 | have been deprecated in favour of the new interactive powers of |
82 | 107 | `use_github_action()` (#1724). |
83 | 108 |
|
84 | | -* `use_data()` now sets the appropriate minimal R version in `DESCRIPTION`, |
85 | | - depending on which serialization format `version` you choose (@dpprdan, #1672). |
86 | | - |
87 | | -* `use_travis()`, `use_pkgdown_travis()`, `browse_travis()`, and `use_appveyor()` |
88 | | - are now defunct because we no longer recommend Travis or Appveyor. We |
89 | | - recommend GitHub actions instead (#1517). |
| 109 | +## Minor improvements and fixes |
90 | 110 |
|
91 | | -* `use_tidy_eval()` is now defunct because it imports and re-exports a large |
92 | | - number of functions that are no longer needed in order to do tidy |
93 | | - evaluation (#1656). |
94 | | - |
95 | | -* `use_r()` and `use_test()` now work with all active files in `R/`, `src/`, |
96 | | - and `tests/testthat/` (#1566). |
97 | | - |
98 | | -* `use_r()` and `use_test()` now work with files containing `.` (#1690). |
99 | | - |
100 | | -* `use_rcpp()`, `use_c()` and friends now work the same way as `use_r()` and |
101 | | - `use_test()`: they'll take the default file name from the file you currently |
102 | | - have open in RStudio. |
103 | | - |
104 | | -* `rename_files()` now also affects files in `src/` (#1585). |
105 | | - |
106 | | -* `git_sitrep()` gains two arguments: `tool` and `scope`, which enables |
107 | | - you to limit the report to, for example, `tool = "git"` or `scope = "user"`. |
108 | | - The default remains to provide a full report. Also, provides more |
109 | | - feedback if git user's information is not set, and checks global git-email |
110 | | - against user-level GitHub PAT (@ijlyttle, #1732, #1714, #1706). |
| 111 | +* Links to the R Packages book have been updated to the second edition of |
| 112 | + the book (#1689). |
111 | 113 |
|
112 | | -* `use_article()` no longer adds the rmarkdown package to `Suggests`. Instead, |
113 | | - if rmarkdown is not already a dependency, it's added to |
114 | | - `Config/Needs/website`. This means that a package that only uses articles |
115 | | - (vs. vignettes) won't gain an unnecessary dependency on rmarkdown (#1700). |
| 114 | +* The SVG badges placed by `use_lifecycle()` have improved accessibility |
| 115 | + features, i.e. they advertise the lifecycle stage via the `aria-label` |
| 116 | + attribute (#1554, https://github.com/r-lib/lifecycle/issues/117). |
| 117 | + |
| 118 | +* `use_rscloud_badge()` has been deprecated in favour of |
| 119 | + `use_posit_cloud_badge()`, and both functions now accept the updated url |
| 120 | + format of Posit Cloud projects (#1670). |
116 | 121 |
|
117 | 122 | * `use_rstudio()` gains a `reformat` argument which omits `.Rproj` settings |
118 | 123 | that enforce file formatting conventions, e.g. around whitespace. |
119 | 124 | `create_from_github()` uses this option when it introduces an `.Rproj` to a |
120 | 125 | project that lacks one, making it easier to follow the project's existing |
121 | 126 | conventions (#1679). |
122 | 127 |
|
123 | | -* The SVG badges placed by `use_lifecycle()` have improved accessibility |
124 | | - features, i.e. they advertise the lifecycle stage via the `aria-label` |
125 | | - attribute (#1554, https://github.com/r-lib/lifecycle/issues/117). |
| 128 | +* `write_over()` and `use_github_file()` gain an overwrite argument (#1748). |
| 129 | + |
| 130 | +## Tidyverse-related |
126 | 131 |
|
127 | | -* Although nested projects are discouraged, they can be useful in development |
128 | | - contexts. `create_package()` now sets the correct package name and returns |
129 | | - the correct package path for a package nested inside a project (#1647). |
| 132 | +* `use_release_issue()` now uses internal `release_extra_revdeps()` to |
| 133 | + add extra revdep sources. Currently only use for internal Posit tooling, |
| 134 | + but we hope to extend to all users in the future (#1610). |
130 | 135 |
|
131 | | -* `git_vaccinated()` now treats a path configured as `core.excludesFile` like |
132 | | - other user-supplied paths; in particular, any use of the `~/` home directory |
133 | | - shortcut is expanded via |
134 | | - [`fs::path_expand()`](https://fs.r-lib.org/reference/path_expand.html) |
135 | | - (@dpprdan, #1560). |
136 | | - |
137 | | -* Updates snapshot tests (#1715). |
| 136 | +* `use_tidy_logo()` is a new function that calls `use_logo()` on the appropriate |
| 137 | + hex sticker PNG file at <https://github.com/rstudio/hex-stickers> (#1871). |
| 138 | + |
| 139 | +## Defunct functions |
| 140 | + |
| 141 | +* `use_tidy_eval()` is now defunct because it imports and re-exports a large |
| 142 | + number of functions that are no longer needed in order to do tidy |
| 143 | + evaluation (#1656). |
| 144 | + |
| 145 | +* `use_travis()`, `use_pkgdown_travis()`, `browse_travis()`, and `use_appveyor()` |
| 146 | + are now defunct because we no longer recommend Travis or Appveyor. We |
| 147 | + recommend GitHub actions instead (#1517). |
138 | 148 |
|
139 | 149 | # usethis 2.1.6 |
140 | 150 |
|
|
0 commit comments