feat: peer-review badge check

ropensci-review-tools / roreviewapi

API endpoint for package reviews via ropensci-review-bot

https://docs.ropensci.org/roreviewapi

4 stars 1 forks source link

feat: peer-review badge check #36

Closed maelle closed 1 year ago

maelle commented 1 year ago

Fix https://github.com/ropensci/software-review-meta/issues/97

@mpadge

should the use of a http link result in FALSE?
what should the function actually return?
what is an example of a function defined in this package and used in an endpoint?

mpadge commented 1 year ago

* should the use of a http link result in FALSE?
Yes, i would think so, if that's your thoughts there too.
* what should the function actually return?
I guess it would need to be sufficient info to diagnose http vs https, so maybe it should return the link if given, overwise an empty string?
* what is an example of a function defined in this package and used in an endpoint?

The srr_counts() function , used in the srrchecks endpoint.

Hope that helps, and thanks for the work already!

maelle commented 1 year ago

@mpadge Feedback needed again! How do I test the new endpoint?

maelle commented 1 year ago

I am aware that at the end, I will need to run some code to conform to your coding style, good thing I wrote a package for that :sweat_smile:

maelle commented 1 year ago

@mpadge two questions

how/when is spaceout run for styling?
if we merge this, how will it be deployed? and when it is deployed do you agree that it is only a matter of updating buffy config?

mpadge commented 1 year ago

* how/when is spaceout run for styling?

spaceout is not yet set up on GHA here, so it's only enforced via my local pre-commit-config. You may just ignore it if you like.

* if we merge this, how will it be deployed?

It will get automatically deployed at midnight on Monday. But i might force a re-deploy today to incorporate badge changes, which is pretty important.

and when it is deployed do you agree that it is only a matter of updating buffy config?

Yes, i'm pretty sure that's right. Wasn't the intention to have this endpoint automatically called on reviewer assignment or something like that? Do we also want to add another external responder, check readme badge? That would be very straightforward.

maelle commented 1 year ago

thanks, so I'll let you handle the styling and merging. :pray:

The point is for this to be called at the same time as approval. After reviewer assignment is when the badge is first suggested. Nice idea reg the new endpoint. I will prepare a config PR.