Skip to content

Commit cbb1de5

Browse files
committed
More NEWS polishing
1 parent 694a791 commit cbb1de5

File tree

1 file changed

+34
-32
lines changed

1 file changed

+34
-32
lines changed

NEWS.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ usethis has a more sophisticated understanding of the default branch and gains s
2626

2727
## Other GitHub-related changes
2828

29+
* `git_sitrep()` and `gh_token_help()` try even harder to help people get on the
30+
happy path with respect to their GitHub PAT (#1400, #1413, #1488, #1489,
31+
#1497).
32+
33+
* The minimum version of gh has been bumped to help / force more people to
34+
upgrade to the gh version that supports current GitHub PAT formats
35+
(@ijlyttle, #1454).
36+
2937
* `use_github_file()` is a new function related to `use_template()`. Instead of
3038
starting from a local file, `use_github_file()` grabs the contents of an
3139
arbitrary file on GitHub that the user has permission to read. It supports
@@ -53,24 +61,25 @@ usethis has a more sophisticated understanding of the default branch and gains s
5361
creating an empty, orphan `gh-pages` branch. This is necessary due to new
5462
GitHub behaviour, where it has become essentially impossible to refer to the
5563
empty tree (#1472).
56-
57-
* The minimum version of gh has been bumped to help / force more people to
58-
upgrade to the gh version that supports current GitHub PAT formats
59-
(@ijlyttle, #1454).
6064

6165
* `use_github()` can create repositories with `"internal"` visibility, a feature
6266
that exists within GitHub Enterprise products (#1505).
63-
64-
* `git_sitrep()` and `gh_token_help()` try even harder to help people get on the
65-
happy path with respect to their GitHub PAT (#1400, #1413, #1488, #1489,
66-
#1497).
6767

68-
* `use_tidy_github_labels()` is the new name for `use_tidy_labels()` (#1430).
68+
## Package development
6969

70-
* `use_tidy_github_actions()` takes over for `use_tidy_ci()`, which is now
71-
deprecated.
70+
* `use_readme_[r]?md()` no longer includes CRAN installation instructions in the
71+
initial template; instead, we only include GitHub-based install instructions
72+
or otherwise prompt the user to update instructions (#1507).
7273

73-
## Package development
74+
* `use_import_from()` is a new function that puts `@importFrom pkg fun`
75+
directives into a package in a consistent location (@malcolmbarrett, #1377).
76+
77+
* `DESCRIPTION` files generated by usethis no longer include `LazyData` by
78+
default, as per new CRAN checks; instead, `LazyData` is now added the first
79+
time you use `use_data()` (@malcolmbarrett, #1404).
80+
81+
* `use_tidy_eval()` has been updated to reflect current recommendations for
82+
using (and therefore exposing) tidy eval in other packages (@lionel-, #1445).
7483

7584
* `use_pkgdown()` automatically uses Bootstrap 5 if the pkgdown version supports
7685
it (anticipated for pkgdown 2.0.0).
@@ -80,35 +89,28 @@ usethis has a more sophisticated understanding of the default branch and gains s
8089
* `use_code_of_conduct()` now requires a `contact` argument to supply contact
8190
details for reporting CoC violations (#1269).
8291

83-
* `use_tidy_release_test_env()` has been deleted since we no longer recommend
84-
including test environments in `cran-comments.md`. There's no evidence that
85-
CRAN finds it useful, and it's annoying to keep up-to-date (#1365).
86-
87-
* Added `use_import_from()` to put `@importFrom pkg fun` into a package in a
88-
consistent way (@malcolmbarrett, #1377).
89-
90-
* `DESCRIPTION` files generated by usethis no longer include `LazyData` by
91-
default, as per new CRAN checks; instead, `LazyData` is now added the first
92-
time you use `use_data()` (@malcolmbarrett, #1404).
93-
9492
* `use_package()` no longer guides the user on how to use a dependency when no
9593
change was made (@malcolmbarrett, #1384).
94+
95+
### Aimed at the tidyverse team
9696

97-
* `use_tidy_eval()` has been updated to reflect current recommendations for
98-
using (and therefore exposing) tidy eval in other packages (@lionel-, #1445).
97+
These functions are exported for anyone to use, but are aimed primarily at the maintainers of tidyverse, r-lib, and tidymodels packages.
9998

100-
* `use_readme_[r]?md()` no longer includes CRAN installation instructions in the
101-
initial template; instead, we only include GitHub-based install instructions
102-
or otherwise prompt the user to update instructions (#1507).
103-
10499
* `use_tidy_dependencies()` is a new function that sets up standard dependencies
105100
used by all tidyverse packages, except those that are designed to be
106101
dependency free (#1423).
107102

108103
* `use_tidy_upkeep_issue()` is a new function similar to `use_release_issue()`
109-
that creates a checklist-style issue to prompt various updates. It is aimed
110-
primarily at the maintainers of tidyverse, r-lib, and tidymodels packages
111-
(#1416).
104+
that creates a checklist-style issue to prompt various updates (#1416).
105+
106+
* `use_tidy_release_test_env()` has been deleted since we no longer recommend
107+
including test environments in `cran-comments.md`. There's no evidence that
108+
CRAN finds it useful, and it's annoying to keep up-to-date (#1365).
109+
110+
* `use_tidy_github_labels()` is the new name for `use_tidy_labels()` (#1430).
111+
112+
* `use_tidy_github_actions()` takes over for `use_tidy_ci()`, which is now
113+
deprecated.
112114

113115
## User-level configuration
114116

0 commit comments

Comments
 (0)