Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Build vignettes and Include tests in Binary packages #40

Merged
merged 11 commits into from
Aug 19, 2024
Merged

Build vignettes and Include tests in Binary packages #40

Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5b31e77
Update test-coverage.yaml
Felixmil Jul 25, 2024
efacd9c
Update test-coverage.yaml
Felixmil Jul 25, 2024
af3784a
Merged upstream/main into main
Felixmil Jul 25, 2024
83aa78a
Merged upstream/main into main
Felixmil Aug 8, 2024
0a926ca
always checkout latest commit on branch
Felixmil Aug 8, 2024
6271c74
force ref for all worklows
Felixmil Aug 8, 2024
2ed8136
Merge branch 'main' of https://github.com/Felixmil/Workflows
Felixmil Aug 19, 2024
64ce53c
Build vignettes in binary packages
Felixmil Aug 19, 2024
0b82eb1
include tests in binary packages
Felixmil Aug 19, 2024
90a3f96
remove redundant comma
Felixmil Aug 19, 2024
79d5c6f
Skip vignettes building during check
Felixmil Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/R-CMD-check-build.yaml
View file
Open in desktop
Copy link
Member

@Yuri05 Yuri05 Aug 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we change the step

     - uses: r-lib/actions/check-r-package@v2
        with:
          upload-snapshots: true
          build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'
          error-on: 'c("error")'

to

     - uses: r-lib/actions/check-r-package@v2
        with:
          upload-snapshots: true
          args: 'c("--no-manual", "--as-cran", "--no-vignettes")'
          build_args: 'c("--no-manual", "--no-build-vignettes")'
          error-on: 'c("error")'

?

Because now vignettes are first built/checked in this step and then are rebuilt again in the next step.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s. also #34

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better to make the process fail faster in case something is wrong in the vignette.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The question for me is what's the more often use case: vignettes contain errors, or vignettes contain no errors?

I think "vignettes contain no errors" would be mostly the case, because the vignettes are modified not as often as the code and ideally a developer should test a modified vignette locally before committing. And then having vignettes built/checked only once would save more time overall.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I agree and changed the workflow accordingly.

Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ jobs:
run: |
output_dir <- file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "built_package")
dir.create(output_dir)
devtools::build(binary = TRUE, path = output_dir)
# first run build() to get a bundle package (that includes rendered vignettes), then create binary.
devtools::build(devtools::build(), binary = TRUE, path = output_dir, , args=c("--preclean", "--install-tests"))
Felixmil marked this conversation as resolved.
Show resolved Hide resolved
Felixmil marked this conversation as resolved.
Show resolved Hide resolved
shell: Rscript {0}

- name: Get package name, version and R versions and store in environment
Expand Down