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

Adding Posit R-CMD-check.yaml #430

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Adding Posit R-CMD-check.yaml #430

merged 2 commits into from
Apr 10, 2024

Conversation

ddsjoberg
Copy link
Collaborator

@ddsjoberg ddsjoberg commented Apr 9, 2024

The snapshot tests are not being run (see #429), and adding this one Posit R CMD Check will ensure they are checked.

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@ddsjoberg ddsjoberg requested a review from cicdguy as a code owner April 9, 2024 23:47
Copy link

github-actions bot commented Apr 9, 2024

Code Coverage

Package Line Rate Health
admiraldev 95%
Summary 95% (1078 / 1131)

Copy link
Collaborator

@cicdguy cicdguy left a comment

Choose a reason for hiding this comment

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

LGTM. We're not enabling the others for Mac and Windows?

@ddsjoberg
Copy link
Collaborator Author

LGTM. We're not enabling the others for Mac and Windows?

Thanks for the quick review @cicdguy ! We could enable them, no issues from me; I was just making the smallest change possible. I'll go ahead and merge this and @bms63 @bundfussr we can chat at our next meeting and enable the other OSs.

@ddsjoberg ddsjoberg merged commit cc45e7e into main Apr 10, 2024
17 checks passed
@ddsjoberg ddsjoberg deleted the r-cmd-check branch April 10, 2024 00:28
@bms63
Copy link
Collaborator

bms63 commented Apr 10, 2024

Should we not just update admiralci common.yml?

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.

3 participants