Log message:
(devel/R-usethis) Updated 2.1.6 to 2.2.0
# usethis 2.2.0
## New functions
* `use_author()` is a new function to introduce a new person into the
`Authors@R` field of DESCRIPTION (@avalcarcel9, #833).
* `use_rstudio_preferences()` lets you set RStudio preferences programmatically
(#1518)
* `use_standalone()` is a new function that makes it easier to use standalone
files provided by various low-level tidyverse packages, like rlang (#1654).
* `use_upkeep_issue()` is a new function to facilitate regular maintenance of
your package. Similar to `use_release_issue()`, it opens an issue in your repo
with a checklist of maintenance tasks. It will include additional bullets
if your package includes an `upkeep_bullets()` function that returns a
character vector (#1794).
## Package development
* Although nested projects are discouraged, they can be useful in development
contexts. `create_package()` now sets the correct package name and returns
the correct package path for a package nested inside a project (#1647).
* `use_article()` no longer adds the rmarkdown package to `Suggests`. Instead,
if rmarkdown is not already a dependency, it's added to
`Config/Needs/website`. This means that a package that only uses articles
(vs. vignettes) won't gain an unnecessary dependency on rmarkdown (#1700).
* `use_data()` now sets the appropriate minimal R version in `DESCRIPTION`,
depending on which serialization format `version` you choose (@dpprdan, #1672).
* `use_github_links()` by default now appends the GitHub url to existing urls in
in the `URL` field of DESCRIPTION, rather than replacing existing urls (#1805).
* `use_latest_dependencies()` no longer affects `Suggests` since those
dependencies are not enforced (#1749).
* `use_news_md()` now places "(development version)" in the header of \
`NEWS.md`
if there is a development version number in `DESCRIPTION`. It also sets the
first bullet to "Initial CRAN submission" when it looks like a \
"new" package
(#1708).
* `use_coverage()` no longer adds covr to `Suggests`, since the `test-coverage`
GitHub Actions workflow takes care of installing covr (@Bisaloo, #1851).
## Package release
* `use_release_issue()` will now remind you to run `use_github_links()` if
necessary (@Bisaloo, #1754)
* `use_release_issue()` now encourages the creation of `NEWS.md` prior to
submission, instead of after (#1755).
* `use_github_release()` now automatically pushes to GitHub (if safe) and
automatically publishes the release, rather than requiring you to edit and
publish the draft (#1385).
* `use_github_release()` no longer fails in the absence of `NEWS.md` (#1755).
* `use_release_issue()` will now remind you to check/close the milestone
corresponding to the release, if it exists (#1642).
* `use_version()` and `use_dev_version()` gain a `push` argument to optionally
push the result after committing. This is used to eliminate a manual step from
the `use_release_issue()` checklist (#1385).
* `use_revdep()` no longer places an email template, because these days we are
more likely to communicate with other maintainers about breaking changes via
GitHub issues and pull requests (#1769).
## Package file management
* `rename_files()` now also affects files in `src/` (#1585).
* `use_r()` and `use_test()` now work with all active files in `R/`, `src/`,
and `tests/testthat/` (#1566).
* `use_r()` and `use_test()` now work with files containing `.` (#1690).
* `use_rcpp()`, `use_c()` and friends now work the same way as `use_r()` and
`use_test()`: they'll take the default file name from the file you currently
have open in RStudio (#1730).
## Git and GitHub
* `create_from_github()` will now use an existing `.Rproj` file if it exists
anywhere in the repo, not just the root directory. This is useful if you're
working with repos that contain tools for multiple languages (#1680).
* `git_sitrep()` gains two arguments: `tool` and `scope`, which enables
you to limit the report to, for example, `tool = "git"` or `scope = \
"user"`.
The default remains to provide a full report. Also, provides more
feedback if git user's information is not set, and checks global git-email
against user-level GitHub PAT (@ijlyttle, #1732, #1714, #1706).
* `git_vaccinated()` now treats a path configured as `core.excludesFile` like
other user-supplied paths; in particular, any use of the `~/` home directory
shortcut is expanded via
[`fs::path_expand()`](https://fs.r-lib.org/reference/path_expand.html)
(@dpprdan, #1560).
* `use_github_action()` now suggests possible actions when called without
arguments (#1724).
* `use_github_actions()`, `use_github_action_check_standard()`,
`use_github_action_check_release()`, and `use_github_action_pr_commands()`
have been deprecated in favour of the new interactive powers of
`use_github_action()` (#1724).
## Minor improvements and fixes
* Links to the R Packages book have been updated to the second edition of
the book (#1689).
* The SVG badges placed by `use_lifecycle()` have improved accessibility
features, i.e. they advertise the lifecycle stage via the `aria-label`
attribute (#1554, https://github.com/r-lib/lifecycle/issues/117).
* `use_rscloud_badge()` has been deprecated in favour of
`use_posit_cloud_badge()`, and both functions now accept the updated url
format of Posit Cloud projects (#1670).
* `use_rstudio()` gains a `reformat` argument which omits `.Rproj` settings
that enforce file formatting conventions, e.g. around whitespace.
`create_from_github()` uses this option when it introduces an `.Rproj` to a
project that lacks one, making it easier to follow the project's existing
conventions (#1679).
* `write_over()` and `use_github_file()` gain an overwrite argument (#1748).
## Tidyverse-related
* `use_release_issue()` now uses internal `release_extra_revdeps()` to
add extra revdep sources. Currently only use for internal Posit tooling,
but we hope to extend to all users in the future (#1610).
* `use_tidy_logo()` is a new function that calls `use_logo()` on the appropriate
hex sticker PNG file at <https://github.com/rstudio/hex-stickers> (#1871).
## Defunct functions
* `use_tidy_eval()` is now defunct because it imports and re-exports a large
number of functions that are no longer needed in order to do tidy
evaluation (#1656).
* `use_travis()`, `use_pkgdown_travis()`, `browse_travis()`, and `use_appveyor()`
are now defunct because we no longer recommend Travis or Appveyor. We
recommend GitHub actions instead (#1517).
|
Log message:
(devel/R-usethis) Updated 2.0.1 to 2.1.5
# usethis 2.1.5
pkgdown-related functions no longer automatically strip a trailing
slash from the pkgdown site URL, in order to play more nicely with
CRAN's URL checks (#1526).
`edit_pkgdown_config()` is a new function that opens the pkgdown YAML
configuration file for the current Project, if such a file exists.
The error thrown when reporting an unsupported GitHub configuration
has been fixed for forward compatibility with a future version of
rlang, i.e. what is anticipated to be rlang v1.0.0.
Version 2.1.4 was never released. Version was advanced from 2.1.4 to
2.1.5 strictly for CRAN (re-)submission purposes.
# usethis 2.1.3
Modified a test to ensure that intermittent GitHub rate limiting does
not lead to ungraceful failure on CRAN.
# usethis 2.1.2
`git_default_branch_rename()` no longer errors on repos where README
exists, but has no badge block.
`git_default_branch_rediscover()` prunes the defunct remote ref to the
old default branch, e.g. `origin/master`.
# usethis 2.1.0
## Git default branch support
usethis has a more sophisticated understanding of the default branch
and gains several functions to support default branch renaming.
* `git_branch_default()` has been renamed to `git_default_branch()`, to place
it logically in the new family of functions. The old name still works, but
that won't be true forever.
* `git_default_branch()` is much more diligent about figuring out the default
branch. Instead of only consulting the local repo, now we integrate local info
with the default branch reported by the `upstream` or `origin` remote, if
applicable.
- This is intended to surface the case where a project has renamed its default
branch and the local repo needs sync up with that.
* `git_default_branch_rediscover()` is a new function that helps contributors
update their local repo (and personal fork, if applicable) when a project/repo
renames its default branch.
* `git_default_branch_rename()` is a new function that helps a repo owner
rename the default branch (both on GitHub and locally).
* `git_default_branch_configure()` is a new function to set the new Git
configuration option `init.defaultBranch`, which controls the name of the
initial branch of new local repos.
* `git_sitrep()` exposes `init.defaultBranch` and surfaces the more
sophisticated analysis of `git_default_branch()`.
## Other GitHub-related changes
* `git_sitrep()` and `gh_token_help()` try even harder to help people get on the
happy path with respect to their GitHub PAT (#1400, #1413, #1488, #1489,
#1497).
* The minimum version of gh has been bumped to help / force more people to
upgrade to the gh version that supports current GitHub PAT formats
(@ijlyttle, #1454).
* `use_github_file()` is a new function related to `use_template()`. Instead of
starting from a local file, `use_github_file()` grabs the contents of an
arbitrary file on GitHub that the user has permission to read. It supports
targeting a specific branch, tag, or commit and can follow a symlink (#1407).
`use_github_file()` now powers `use_github_action()` and friends.
* `use_github_release()` is much more diligent about using any information left
behind by `devtools::submit_cran()` or `devtools::release()`. Specifically,
this applies to determining which SHA is to be tagged in the release. And this
SHA, in turn, determines the consulted versions of DESCRIPTION (for package
version) and NEWS.md (for release notes) (#1380).
* `use_release_issue()` also takes bullets from `release_questions()`,
for compatibility with `devtools::release()`.
* `git_vaccinate()`, `edit_git_ignore()`, and `git_sitrep()` are more careful to
consult, reveal, and set the `core.excludesFile` setting in user's Git
configuration (#1461).
* `use_github_action_check_full()` has been removed. It's overkill for the
majority of R packages, which are better off with `use_github_actions()` or
`use_github_action_check_standard()` (#1490).
* `use_github_pages()` and `use_pkgdown_github_pages()` use a new method for
creating an empty, orphan `gh-pages` branch. This is necessary due to new
GitHub behaviour, where it has become essentially impossible to refer to the
empty tree (#1472).
* `use_github()` can create repositories with `"internal"` visibility, \
a feature
that exists within GitHub Enterprise products (#1505).
## Package development
* `use_readme_[r]?md()` no longer includes CRAN installation instructions in the
initial template; instead, we only include GitHub-based install instructions
or otherwise prompt the user to update instructions (#1507).
* `use_import_from()` is a new function that puts `@importFrom pkg fun`
directives into a package in a consistent location (@malcolmbarrett, #1377).
* `DESCRIPTION` files generated by usethis no longer include `LazyData` by
default, as per new CRAN checks; instead, `LazyData` is now added the first
time you use `use_data()` (@malcolmbarrett, #1404).
* `use_tidy_eval()` has been updated to reflect current recommendations for
using (and therefore exposing) tidy eval in other packages (@lionel-, #1445).
* `use_pkgdown()` automatically uses Bootstrap 5 if the pkgdown version supports
it (anticipated for pkgdown 2.0.0).
* `use_lifecycle()` now imports `lifecycle::deprecated()` (#1419).
* `use_code_of_conduct()` now requires a `contact` argument to supply contact
details for reporting CoC violations (#1269).
* `use_package()` no longer guides the user on how to use a dependency when no
change was made (@malcolmbarrett, #1384).
### Aimed at the tidyverse team
These functions are exported for anyone to use, but are aimed
primarily at the maintainers of tidyverse, r-lib, and tidymodels
packages.
* `use_tidy_dependencies()` is a new function that sets up standard dependencies
used by all tidyverse packages, except those that are designed to be
dependency free (#1423).
* `use_tidy_upkeep_issue()` is a new function similar to `use_release_issue()`
that creates a checklist-style issue to prompt various updates (#1416).
* `use_tidy_release_test_env()` has been deleted since we no longer recommend
including test environments in `cran-comments.md`. There's no evidence that
CRAN finds it useful, and it's annoying to keep up-to-date (#1365).
* `use_tidy_github_labels()` is the new name for `use_tidy_labels()` (#1430).
* `use_tidy_github_actions()` takes over for `use_tidy_ci()`, which is now
deprecated.
## User-level configuration
* `"usethis.overwrite"` is a new option. When set to `TRUE`, usethis \
overwrites
an existing file without asking for user confirmation if the file is inside
a Git repo. The normal Git workflow makes it easy to see and selectively
accept/discard any proposed changes. This behaviour is strictly opt-in
(#1424).
* Functions that provide code to load packages in your `.Rprofile` now use
`rlang::check_installed()` to make sure the package is installed locally
(@malcolmbarrett, #1398).
* `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 (@charliejhadley, #1420).
|
Log message:
(devel/R-usethis) Updated 1.6.3 to 2.0.0, sorry for long log
See also:
https://www.tidyverse.org/blog/2020/12/usethis-2-0-0/
# usethis 2.0.0
This version is anticipated to be released as usethis v2.0.0.
## Adoption of gert and changes to Git/GitHub credential handling
Usethis has various functions that help with Git-related tasks, which
break down into two categories:
1. Git tasks, such as clone, push, and pull. These are things you
could do with command line Git.
1. GitHub tasks, such as fork, release, and open an issue or pull
request. These are things you could do in the browser or with the
GitHub API.
We've switched from git2r to the gert package for Git operations
(<https://docs.ropensci.org/gert/>). We continue to use the gh package
for GitHub API work (<https://gh.r-lib.org>).
The big news in this area is that these lower-level dependencies are
getting better at finding Git credentials, finding the same
credentials as command line Git (and, therefore, the same as RStudio),
and finding the same credentials as each other. This allows usethis to
shed some of the workarounds we have needed in the past, to serve as a
remedial "credential valet".
Under the hood, both gert and gh are now consulting your local Git
credential store, when they need credentials. At the time of writing,
they are using two different even-lower-level packages to do this:
* gert uses the credentials package (<https://docs.ropensci.org/credentials/>)
* gh uses the gitcreds package (<https://gitcreds.r-lib.org/>)
Even now, gert and gh should discover the same credentials, at least
for github.com. In the future, these two packages may merge into one.
Git/GitHub credential management is covered in a new article:
[Managing Git(Hub)
Credentials](https://usethis.r-lib.org/articles/articles/git-credentials.html)
The main user-facing changes in usethis are:
* usethis should discover and use the same credentials as command line Git.
* usethis should be able to work with any GitHub deployment. While
github.com is the default, GitHub Enterprise deployments are fully
supported. The target GitHub host is determined from the current
project's configured GitHub remotes, whenever possible.
As a result, several functions are deprecated and several other
functions have some deprecated arguments.
* Deprecated functions:
- `use_git_credentials()`
- `git_credentials()`
- `github_token()`
* Functions with (deprecated arguments):
- `create_from_github()` (`auth_token`, `credentials`)
- `use_github()` (`auth_token`, `credentials`)
- `use_github_links()` (`host`, `auth_token`)
- `use_github_labels()` (`repo_spec`, `host`, `auth_token`)
- `use_tidy_labels()` (`repo_spec`, `host`, `auth_token`)
- `use_github_release()` (`host`, `auth_token`)
The switch to gert + credentials should eliminate most
credential-finding fiascos. Gert also takes a different approach to
wrapping libgit2, the underlying C library that does Git
operations. The result is more consistent support for SSH and TLS,
across all operating systems, without requiring special effort at
install time. More users should enjoy Git remote operations that "just
work", for both SSH and HTTPS remotes. There should be fewer
"unsupported protocol" errors.
## GitHub remote configuration
Usethis gains a more formal framework for characterizing a GitHub
remote configuration. We look at:
* Which GitHub repositories `origin` and `upstream` point to
* Whether you can push to them
* How they relate to each other, e.g. fork-parent relationship
This is an internal matter, but users will notice that usethis is more
clear about which configurations are supported by various functions
and which are not. The most common configurations are reviewed in a
[section of Happy
Git](https://happygitwithr.com/common-remote-setups.html).
When working in a fork, there is sometimes a question whether to
target the fork or its parent repository. For example,
`use_github_links()` adds GitHub links to the URL and BugReports
fields of DESCRIPTION. If someone calls `use_github_links()` when
working in a fork, they probably want those links to refer to the
*parent* or *source* repo, not to their fork, because the user is
probably preparing a pull request. Usethis should now have better
default behaviour in these situations and, in some cases, will present
an interactive choice.
## Default branch
There is increasing interest in making the name of a repo's default
branch configurable. Specifically, `main` is emerging as a popular
alternative to `master`. Usethis now discovers the current repo's
default branch and uses that everywhere that, previously, we had
hard-wired `master`.
`git_branch_default()` is a newly exported function that is also what's used \
internally.
`use_course()`, `use_zip()`, and `create_download_url()` all have some
support for forming the URL to download a `.zip` archive of a repo,
based on a repo specification (e.g. `OWNER/REPO`) or a browser
URL. These helpers now form a URL that targets `HEAD` of the repo,
i.e. the default branch.
## Changes to Git/GitHub functionality
The default Git protocol is now "https" and we no longer provide an
interactive choice, by default, in interactive sessions. As always, a
user can express a preference for "ssh" in individual function calls,
for an R session via `use_git_protocol()`, and for all R sessions via
the `usethis.protocol` option (#1262).
`pr_resume()` is a new function for resuming work on an existing local
PR branch. It can be called argument-less, to select a branch
interactively.
`pr_fetch()` can also be called with no arguments, to select a PR
interactively. The `owner` argument is replaced by `target`, with a
choice of the source (default) or primary repo.
`pr_forget()` is a new function for abandoning a PR you initiated
locally or fetched from GitHub. It only does local clean up and, for
example, doesn't delete a remote branch or close a PR (#1263).
`pr_view()` can now be called with no arguments. If the current branch
is associated with an open PR, we target that and, otherwise, we offer
an interactive selection.
`pr_finish()` deletes the remote PR branch if the PR has been merged
and the current user has the power to do so, i.e. an external
contributor deleting their own branch or a maintainer deleting a
branch associated with an internal PR (#1150). It no longer errors if
the PR branch has already been deleted (#1196).
`pr_pull_upstream()` is renamed to `pr_merge_main()` to emphasize that
it merges the **main** line of development into the current branch,
where the main line of development is taken to mean the default
branch, as reported by `git_branch_default()`, of the source repo,
which could be either `upstream` or `origin`, depending on the
situation.
`create_from_github()` will only create a read-only clone, due to lack
of a GitHub personal access token, if explicitly directed to do so via
`fork = FALSE`.
`create_from_github()` and `use_tidy_thanks()` accept browser and Git
URLs as the `repo_spec` argument, to be friendlier to copy/paste. When
a URL is passed, the `host` is also extracted from it.
`create_github_token()` is a new name for the function previously
known as `browse_github_token()` and `browse_github_pat()`.
`issue_close_community()` and `issue_reprex_needed()` are two new
functions for maintainers who process lots of GitHub issues. They
automate canned replies and actions, e.g. labelling or closing (#940).
GitHub Actions is the preferred platform for continuous integration,
because that is what the tidyverse team currently uses and
maintains. Functions related to Travis-CI and AppVeyor are
soft-deprecated to raise awareness about this change and to make it
clear that, if substantial maintenance becomes necessary, we may elect
to retire the function (#1169).
`browse_github_actions()` is a new function to open the Actions page
of the respective repo on GitHub, similar to existing `browse_*()`
functions (@pat-s, #1102).
`use_github_pages()` is a new function to activate or reconfigure the
GitHub Pages site associated with a repository (#224).
`use_tidy_pkgdown()` implements the complete pkgdown configuration
used by the tidyverse team (#224).
`pr_sync()` is defunct and can be replicated by calling `pr_pull()`,
`pr_merge_main()`, then `pr_push()`.
## Licensing improvements
All `use_*_license()` functions now work for projects, not just
packages.
`use_apl2_license()` (not `use_apache_license()`) and
`use_gpl3_license()` no longer modify the license text (#1198).
`use_mit_license()` now sets the default copyright holder to
"{package} authors". This makes it more clear that the copyright
holders are the contributors to the package; unless you are using a
CLA there is no one copyright holder of a package (#1207).
New `use_gpl_license()` and `use_agpl_license()` make it easier to
pick specific versions of the GPL and AGPL licenses, and to choose
whether or not you include future versions of the license. Both
default to version 3 (and above).
New `use_proprietary_license()` allows your package to pass R CMD
check while making it clear that your code is not open source
(#1163). Thanks to @atheriel for the blog post suggesting the wording:
https://unconj.ca/blog/copyright-in-closed-source-r-packages-the-right-way.html
`use_lgpl_license()` now uses version 3 (and above), and gains new
`version` and `include_future` argument to control which version is
used.
`use_gpl3_license()`, `use_agpl3_license()` and `use_apl2_license()`
have been deprecated in favour of the new `version` argument to
`use_gpl_license()`, `use_agpl_license()` and `use_apache_license()`.
The `name` argument to `use_mit_license()` has been changed to
`copyright_holder` to make the purpose more clear. The `name` argument
has been removed from all other license functions because it is not
needed; no other license makes an assertion about who the copyright
holder is.
## RStudio preferences
usethis is now fully cognizant of the [changes to RStudio
preferences](https://blog.rstudio.com/2020/02/18/rstudio-1-3-preview-configuration/)
in RStudio 1.3:
`edit_rstudio_snippets()` looks in the new location, and if you have
snippets in the old location, will automatically copy them to the new
location (#1204)
New `edit_rstudio_prefs()` opens RStudio preferences file for editing
(#1148).
`use_blank_slate()` can now configure your global, i.e. user-level,
RStudio preference, in addition to project-level (#1018).
## Other changes
`browse_package()` and `browse_project()` are new functions that let
the user choose from a list of URLs derived from local Git remotes and
DESCRIPTION (local or possibly on CRAN) (#1113).
The legacy `"devtools.desc"` option is no longer consulted when
populating a new DESCRIPTION file. You must use the
`"usethis.description"` now (#1069).
`use_dev_package()` gains a `remote` parameter to allow you to specify
the remote. The existing behaviour, which adds an `OWNER/REPO` GitHub
remote, remains the default (#918, @ijlyttle).
`use_cpp11()` is a new function to set up an R package to use cpp11.
`create_package(roxygen = FALSE)` once again writes a valid NAMESPACE
file (and also has no Roxygen* fields in DESCRIPTION) (#1120).
`create_package()`, `create_project()`, `create_from_github()`, and
`proj_activate()` work better with relative paths, inside and outside
of RStudio (#1122, #954).
`use_testthat()` gains an edition argument to support testthat v3.0.0
(#1185)
`use_version()` now updates `src/version.c` if it exists and contains
a line matching `PKG_version = "x.y.z";`.
usethis has been re-licensed as MIT (#1252, #1253).
## Dependency changes
New Imports: gert, jsonlite (was already an indirect dependency),
lifecycle, rappdirs
No longer in Imports: git2r, rematch2
|