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.

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

Build vignettes and Include tests in Binary packages #40

Merged
merged 11 commits into from
Aug 19, 2024

Conversation

Felixmil
Copy link
Contributor

@Felixmil Felixmil commented Aug 19, 2024

@Felixmil Felixmil changed the title Build vignettes Build vignettes and Include tests in Binary packags Aug 19, 2024
@Felixmil Felixmil changed the title Build vignettes and Include tests in Binary packags Build vignettes and Include tests in Binary packages Aug 19, 2024
Copy link
Member

@Yuri05 Yuri05 Aug 19, 2024

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.

@Yuri05
Copy link
Member

Yuri05 commented Aug 19, 2024

@Felixmil Also maybe you could address the issue Open-Systems-Pharmacology/OSPSuite-R#1477 in this PR?

@Felixmil
Copy link
Contributor Author

Felixmil commented Aug 19, 2024

@Felixmil Also maybe you could address the issue Open-Systems-Pharmacology/OSPSuite-R#1477 in this PR?

This was done in Open-Systems-Pharmacology/OSPSuite-R#1481 as a repo-specific setting.

@Yuri05
Copy link
Member

Yuri05 commented Aug 19, 2024

This was done in Open-Systems-Pharmacology/OSPSuite-R#1481 as a repo-specific setting.

Great! 👍

@Yuri05 Yuri05 merged commit 24c77b4 into Open-Systems-Pharmacology:main Aug 19, 2024
1 check passed
@Felixmil Felixmil deleted the build-vignettes branch August 19, 2024 14:41
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.

Vignettes are missing in the package Tests are missing in the Linux package
2 participants