Check the reverse dependencies of a package using the crandalf service: https://github.com/yihui/crandalf. If the number of reverse dependencies is large, they will be split into batches and pushed to crandalf one by one.
Usage
crandalf_check(pkg, size = 400, jobs = Inf, which = "all")
crandalf_results(pkg, repo = NA, limit = 200, wait = 5 * 60)Arguments
- pkg
The package name of which the reverse dependencies are to be checked.
- size
The number of reverse dependencies to be checked in each job.
- jobs
The number of jobs to run in GitHub Actions (by default, all jobs are submitted, but you can choose to submit the first few jobs).
- which
The type of dependencies (see
rev_check()).- repo
The crandalf repo on GitHub (of the form
user/reposuch as"yihui/crandalf"). Usually you do not need to specify it, unless you are not calling this function inside the crandalf project, becauseghshould be able to figure out the repo automatically.- limit
The maximum of records for
gh run listto retrieve. You only need a larger number if the check results are very early in the GitHub Action history.- wait
Number of seconds to wait if not all jobs have been completed on GitHub. By default, this function checks the status every 5 minutes until all jobs are completed. Set
waitto 0 to disable waiting (and throw an error immediately when any jobs are not completed).
Details
Due to the time limit of a single job on GitHub Actions (6 hours), you will
have to split the large number of reverse dependencies into batches and check
them sequentially on GitHub (at most 5 jobs in parallel). The function
crandalf_check() does this automatically when necessary. It requires
the git command to be available.
The function crandalf_results() fetches check results from GitHub
after all checks are completed, merge the results, and show a full summary of
check results. It requires gh (GitHub CLI:
https://cli.github.com/manual/) to be installed and you also need to
authenticate with your GitHub account beforehand.