Skip to content

Closes #2984 pr_website: enable PR website#2985

Merged
bundfussr merged 2 commits intomainfrom
2984_pr_website
Feb 18, 2026
Merged

Closes #2984 pr_website: enable PR website#2985
bundfussr merged 2 commits intomainfrom
2984_pr_website

Conversation

@bundfussr
Copy link
Copy Markdown
Collaborator

@bundfussr bundfussr commented Feb 18, 2026

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?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • 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). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • 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!

@github-actions
Copy link
Copy Markdown
Contributor

Code Coverage

Package Line Rate Health
admiral 100%
Summary 100% (6131 / 6144)

@bundfussr bundfussr linked an issue Feb 18, 2026 that may be closed by this pull request
@bundfussr
Copy link
Copy Markdown
Collaborator Author

@bms63 , @manciniedoardo , should I do the same update in admiraldev?

@manciniedoardo
Copy link
Copy Markdown
Collaborator

makes sense! thanks

@bms63
Copy link
Copy Markdown
Collaborator

bms63 commented Feb 18, 2026

@bms63 , @manciniedoardo , should I do the same update in admiraldev?

If easy to do sure - but feels like we won't use it very much.

Copy link
Copy Markdown
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

do we want to do plan a demo for this at next admiral meeting?

@bundfussr
Copy link
Copy Markdown
Collaborator Author

@bms63 , @manciniedoardo , should I do the same update in admiraldev?

If easy to do sure - but feels like we won't use it very much.

We could use it for pharmaverse/admiraldev#540.

@bundfussr
Copy link
Copy Markdown
Collaborator Author

do we want to do plan a demo for this at next admiral meeting?

Makes sense to me.

Maybe also a topic for the "admiral family gathering" meeting. @manciniedoardo

@bundfussr bundfussr merged commit 870a3cc into main Feb 18, 2026
16 of 17 checks passed
@bundfussr bundfussr deleted the 2984_pr_website branch February 18, 2026 17:08
@manciniedoardo
Copy link
Copy Markdown
Collaborator

do we want to do plan a demo for this at next admiral meeting?

Makes sense to me.

Maybe also a topic for the "admiral family gathering" meeting. @manciniedoardo

noted for next week when i send out the agenda 😄

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.

Feature Request: Enable optional website creation for PRs

3 participants