Skip to content

Mark network examples as \dontrun to prevent CI failures#24

Merged
brshallo merged 2 commits intomainfrom
copilot/mark-examples-as-dontrun-again
Jan 29, 2026
Merged

Mark network examples as \dontrun to prevent CI failures#24
brshallo merged 2 commits intomainfrom
copilot/mark-examples-as-dontrun-again

Conversation

Copy link
Contributor

Copilot AI commented Jan 29, 2026

R CMD check with --run-donttest executes \donttest{} blocks, causing CI failures when examples make GitHub API calls. Changed example wrappers from \donttest{} to \dontrun{} which are never executed during checks.

Changes

  • R source files: Updated example blocks in 4 files to use \dontrun{}

    • R/spot-files.R (2 examples)
    • R/list-files-wd.R
    • R/network-plot.R
    • R/list-files-gh-repo.R
  • Documentation files: Regenerated 5 man/*.Rd files to reflect updated examples

    • man/spot_funs_files.Rd
    • man/unnest_results.Rd
    • man/list_files_wd.Rd
    • man/network_plot.Rd
    • man/list_files_github_repo.Rd

All affected examples call list_files_github_repo() which makes network requests to GitHub's API.

Original prompt

Mark network examples as \dontrun to avoid network calls in R CMD check

Problem summary:
The R CMD check in CI is failing when running examples with --run-donttest because several examples perform GitHub API requests. These should not be executed during package checks. Currently examples are wrapped in \donttest{ ... } which are still executed with --run-donttest. To prevent execution during checks, convert those example blocks to \dontrun{ ... }.

Goal:

  • Update example blocks in R source files so that networked examples are wrapped with \dontrun{ ... } instead of \donttest{ ... }.
  • Run roxygen2::roxygenise('.') to regenerate man/*.Rd files.
  • Commit changes to the open PR branch copilot/add-roxygen-documentation-list-files-github-gists.
  • Push and update the open PR.

Files to change (examples only):

  • R/spot-files.R
  • R/list-files-wd.R
  • R/network-plot.R
  • R/list-files-gh-repo.R

Commit message:
Mark network examples as \dontrun to avoid network calls in R CMD check

Pull request:
Update the existing PR (22) branch copilot/add-roxygen-documentation-list-files-github-gists

Notes:

  • Keep behavior of functions unchanged, only alter example wrappers and regenerate Rd files.

This pull request was created from Copilot chat.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Update network examples to use \dontrun in R source files Mark network examples as \dontrun to prevent CI failures Jan 29, 2026
Copilot AI requested a review from brshallo January 29, 2026 04:48
@brshallo brshallo marked this pull request as ready for review January 29, 2026 05:00
@brshallo brshallo merged commit 840223d into main Jan 29, 2026
5 checks passed
@brshallo brshallo deleted the copilot/mark-examples-as-dontrun-again branch January 29, 2026 05:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants