Skip to content

Commit 2aa4060

Browse files
committed
Work on NEWS
1 parent 5399b9d commit 2aa4060

File tree

1 file changed

+62
-40
lines changed

1 file changed

+62
-40
lines changed

NEWS.md

Lines changed: 62 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,22 @@ usethis has a more sophisticated understanding of the default branch and gains s
2424
* `git_sitrep()` exposes `init.defaultBranch` and surfaces the more
2525
sophisticated analysis of `git_default_branch()`.
2626

27-
## Other
27+
## Other GitHub-related changes
2828

29-
* `use_github_file()` is a new function related to `use_template()`, which grabs
30-
the contents of an arbitrary file on GitHub, with support for targeting a
31-
specific branch, tag, or commit and for following symlinks (#1407). It is now
32-
used by `use_github_action()` and friends.
29+
* `use_github_file()` is a new function related to `use_template()`. Instead of
30+
starting from a local file, `use_github_file()` grabs the contents of an
31+
arbitrary file on GitHub that the user has permission to read. It supports
32+
targeting a specific branch, tag, or commit and can follow a symlink (#1407).
33+
`use_github_file()` now powers `use_github_action()` and friends.
3334

3435
* `use_release_issue()` also takes bullets from `release_questions()`,
3536
for compatibility with `devtools::release()`.
3637

37-
* `use_pkgdown()` automatically uses bootstrap4 if the pkgdown version supports
38-
it (anticipated for pkgdown 2.0.0).
39-
4038
* `git_vaccinate()`, `edit_git_ignore()`, and `git_sitrep()` are more careful to
41-
consult, reveal, and set the `core.excludesFile` in user's Git configuration
42-
(#1461).
43-
44-
* `use_github_action_*()` functions have been updated in response to the
45-
pak-based workflows becoming the standard workflows in `r-lib/actions`.
39+
consult, reveal, and set the `core.excludesFile` setting in user's Git
40+
configuration (#1461).
4641

47-
* `use_github_action_check_full()` has been removed since it's overkill for the
42+
* `use_github_action_check_full()` has been removed. It's overkill for the
4843
majority of R packages, which are better off with `use_github_actions()` or
4944
`use_github_action_check_standard()` (#1490).
5045

@@ -53,48 +48,75 @@ usethis has a more sophisticated understanding of the default branch and gains s
5348
GitHub behaviour, where it has become essentially impossible to refer to the
5449
empty tree (#1472).
5550

56-
* `"usethis.overwrite"` is a new option. When set to `TRUE`, usethis overwrites
57-
an existing file without asking for user confirmation if the file is inside
58-
a Git repo. The normal Git workflow makes it easy to see and selectively
59-
accept/discard any proposed changes. This behaviour is strictly opt-in
60-
(#1424).
51+
* `use_tidy_labels()` has been renamed to `use_tidy_github_labels()` (#1430).
52+
53+
* The minimum version of gh has been bumped to help / force more people to
54+
upgrade to the gh version that supports current GitHub PAT formats
55+
(@ijlyttle, #1454).
56+
57+
* `use_github()` can create repositories with `"internal"` visiblity, a feature
58+
that exists within GitHub Enterprise products (#1505).
6159

60+
* `git_sitrep()` and `gh_token_help()` try even harder to help people get on the
61+
happy path with respect to their GitHub PAT (#1400, #1413, #1488, #1489,
62+
#1497).
63+
64+
* `use_tidy_github_labels()` is the new name for `use_tidy_labels()` (#1430).
65+
66+
* `use_tidy_github_actions()` takes over for `use_tidy_ci()`, which is now
67+
deprecated.
68+
69+
## Package development
70+
71+
* `use_pkgdown()` automatically uses bootstrap4 if the pkgdown version supports
72+
it (anticipated for pkgdown 2.0.0).
73+
6274
* `use_lifecycle()` now imports `lifecycle::deprecated()` (#1419).
6375

6476
* `use_code_of_conduct()` now requires a `contact` argument to supply contact
6577
details for reporting CoC violations (#1269).
6678

67-
* We no longer suggest including your test environments in `cran-comments.md`,
68-
since there's no evidence that CRAN finds it useful, and it's annoying to
69-
keep up to date (#1365).
70-
7179
* `use_tidy_release_test_env()` has been deleted since we no longer recommend
72-
including test environment in CRAN comments (#1365).
80+
including test environments in `cran-comments.md`. There's no evidence that
81+
CRAN finds it useful, and it's annoying to keep up-to-date (#1365).
7382

7483
* Added `use_import_from()` to put `@importFrom pkg fun` into a package in a
75-
consistent way (@malcolmbarrett, #1377)
84+
consistent way (@malcolmbarrett, #1377).
7685

7786
* `DESCRIPTION` files generated by usethis no longer include `LazyData` by
78-
default per new CRAN checks; instead, `LazyData` is now added the first time
79-
you use `use_data()` (@malcolmbarrett, #1404)
80-
81-
* Functions that provide code to load packages in your `.Rprofile` now use
82-
`rlang::check_installed()` to make sure the package is installed locally
83-
(@malcolmbarrett, #1398)
84-
87+
default, as per new CRAN checks; instead, `LazyData` is now added the first
88+
time you use `use_data()` (@malcolmbarrett, #1404).
89+
8590
* `use_package()` no longer guides the user on how to use a dependency when no
86-
change was made (@malcolmbarrett, #1384)
87-
88-
* The minimum version of gh has been bumped to help more people upgrade to the gh version that supports current GitHub PAT formats (#1454 @ijlyttle).
91+
change was made (@malcolmbarrett, #1384).
8992

90-
* `edit_rstudio_prefs()` and `edit_rstudio_snippets()` should work now on case-sensitive OSes, due to a path fix re: the location of RStudio's config files (#1420 @charliejhadley).
93+
* `use_tidy_eval()` has been updated to reflect current recommendations for
94+
using (and therefore exposing) tidy eval in other packages (@lionel-, #1445).
9195

92-
* `use_tidy_eval()` has been updated to reflect current recommendations for using (and therefore exposing) tidy eval in other packages (@lionel-, #1445).
96+
* `use_readme_[r]?md()` no longer includes CRAN installation instructions in the
97+
initial template; instead, we only include GitHub-based install instructions
98+
or otherwise prompt the user to update instructions (#1507).
99+
100+
* `use_tidy_dependencies()` is a new function that sets up standard dependencies
101+
used by all tidyverse packages, except those that are designed to be
102+
dependency free (#1423).
93103

94-
* `use_tidy_labels()` has been renamed to `use_tidy_github_labels()` (#1430).
95104

96-
* `use_readme_[r]?md()` no longer includes CRAN install instructions in the
97-
initial template; instead, we only include GitHub-based install instructions or otherwise prompt the user to update instructions (#1507).
105+
## User-level configuration
106+
107+
* `"usethis.overwrite"` is a new option. When set to `TRUE`, usethis overwrites
108+
an existing file without asking for user confirmation if the file is inside
109+
a Git repo. The normal Git workflow makes it easy to see and selectively
110+
accept/discard any proposed changes. This behaviour is strictly opt-in
111+
(#1424).
112+
113+
* Functions that provide code to load packages in your `.Rprofile` now use
114+
`rlang::check_installed()` to make sure the package is installed locally
115+
(@malcolmbarrett, #1398).
116+
117+
* `edit_rstudio_prefs()` and `edit_rstudio_snippets()` should work now on
118+
case-sensitive OSes, due to a path fix re: the location of RStudio's config
119+
files (@charliejhadley, #1420).
98120

99121
# usethis 2.0.1
100122

0 commit comments

Comments
 (0)