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

R CMD CHECK note #288

Closed
2 tasks done
pawelru opened this issue Sep 30, 2024 · 3 comments · Fixed by #290 or #291
Closed
2 tasks done

R CMD CHECK note #288

pawelru opened this issue Sep 30, 2024 · 3 comments · Fixed by #290 or #291

Comments

@pawelru
Copy link
Contributor

pawelru commented Sep 30, 2024

* checking files in ‘vignettes’ ... NOTE
Files named as vignettes but with no recognized vignette engine:
   ‘vignettes/_setup.Rmd’
(Is a VignetteBuilder field missing?)
@pawelru pawelru linked a pull request Nov 27, 2024 that will close this issue
@pawelru
Copy link
Contributor Author

pawelru commented Nov 27, 2024

Hey @llrs-roche, I have linked your PR as this essentially solves the issue but can you also have a look at the CI part so that it would be automatically captured by CI on commit (instead of external testing service)

@llrs-roche
Copy link
Contributor

Oh, I didn't realize there was already an issue for this.
The list on the blocklist seems to only use the official R message, not the specific note/warning/error (if any(. I'll try to see if it is possible to capture that.

@pawelru
Copy link
Contributor Author

pawelru commented Nov 27, 2024

That list is collapsed into one string with | and then there is a simple regular expression on the R CMD CHECK output. It means that we just need to extend it with yet another element against that use case.
The good/bad thing about this is that that list is defined for each repo. It's good because it allows for exceptions. It's bad because if we want to extend the list for all pkgs then it means a lot of PRs. I know IDR team has some magic tool that does such propagation - in such case let's create a task and explain in detail what and where. They are doing this periodically when number of requests reach some threshold (whatever it is). But it's important to note it.

@llrs-roche llrs-roche linked a pull request Nov 28, 2024 that will close this issue
llrs-roche added a commit that referenced this issue Jan 29, 2025
This PR is to add the notes to the CI part per
#288 but only
for teal.reporter.

The changes do not look to the general issue as vignettes failing to
build could be due to a number of reasons. As far as I know the string I
added is specific for this error. To fix the issue PR #290 was already
merge so I don't expect any failures now.

This could be added to the default/general check from r.pkg.template if
it meets the IDR requirements.

---------

Signed-off-by: Lluís Revilla <[email protected]>
Co-authored-by: Marcin <[email protected]>
llrs-roche added a commit to insightsengineering/r.pkg.template that referenced this issue Feb 11, 2025
# Pull Request

Following
insightsengineering/teal.reporter#288 this PR
add this note as a blocking note.

I added the note to several workflows (based on a [PR on other
repositories](insightsengineering/teal.reporter#291)),
let me know if this is a good approach.

---------

Co-authored-by: Marcin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants