pharmaverse / admiral

ADaM in R Asset Library
https://pharmaverse.github.io/admiral
Apache License 2.0
220 stars 61 forks source link

Closes #2382 #2384 error messaging updates from admiraldev #2383

Closed bms63 closed 5 months ago

bms63 commented 5 months ago

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.

github-actions[bot] commented 5 months ago

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (4730 / 4818)
bms63 commented 5 months ago

Anyways I don’t think k remotes is actually needed

ddsjoberg commented 5 months ago

Anyways I don’t think k remotes is actually needed

Remotes isn't needed for the workflows that run on CI/CD if that workflow uses staged deps to set up the packages. If a workflow isn't using staged deps, it will fail without Remotes. Also an annoying thing that happens to users is they come across the admiral repo and install it from GitHub it won't work because you need the dev version of admiraldev and without Remotes, there is no way for the installation process to know where to get it from.

It's fine for us, the devs, to depend on tools like staged deps. But we should keep up our repo in a state so that anyone coming to the repo can install the package. This means adding Remotes when we depend on dev versions of packages.

bms63 commented 5 months ago

Anyways I don’t think k remotes is actually needed

Remotes isn't needed for the workflows that run on CI/CD if that workflow uses staged deps to set up the packages. If a workflow isn't using staged deps, it will fail without Remotes. Also an annoying thing that happens to users is they come across the admiral repo and install it from GitHub it won't work because you need the dev version of admiraldev and without Remotes, there is no way for the installation process to know where to get it from.

It's fine for us, the devs, to depend on tools like staged deps. But we should keep up our repo in a state so that anyone coming to the repo can install the package. This means adding Remotes when we depend on dev versions of packages.

Ah okay - I was thinking that our CI could use remotes now (thought that was a reason to rework CI R-CMD checks).

makes sense for users wishing to install dev versions

bms63 commented 5 months ago

If everything looks okay can you approve so we can update the other PRs to pass CI