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

Host review status badge at pyopensci.org #293

Open
4 tasks done
sneakers-the-rat opened this issue Jun 27, 2024 · 7 comments
Open
4 tasks done

Host review status badge at pyopensci.org #293

sneakers-the-rat opened this issue Jun 27, 2024 · 7 comments

Comments

@sneakers-the-rat
Copy link
Contributor

sneakers-the-rat commented Jun 27, 2024

Finishing up a review now, and i see that the badge uses tinyurl:

- [ ] Add the badge for pyOpenSci peer-review to the README.md of <package-name-here>. The badge should be `[![pyOpenSci](https://tinyurl.com/y22nb8up)](https://github.com/pyOpenSci/software-review/issues/issue-number)`.

that resolves to this big old thing:

expand/collapse link

https://img.shields.io/badge/PyOpenSci-Peer%20Reviewed-success.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHIAAABnCAYAAADcxhZVAAAACXBIWXMAAAWJAAAFiQFtaJ36AAAHXUlEQVR4nO1dy3EbORBtq3SX9oiTtBGIG4HoCCxHYG4EpiIQFYGpCExFYCoCUxEsGcFyTziuGIG2wHpjDrnzwTQaMwMMXhWrVJI4vzfofzc+vL+/k29orcdEdI2PwbjilGsieiOirflZKbX2foERwAuRWmtD2B0+twKHfCGipfkopd4EjhcdRInUWl8S0ZyIvnh6UDscf54IPYYYkVrrERGtiOhC7vJKYQgdJ7F7wJnEQVomkXCeFc47eJAUkRB3pyT+Q0RPRPTs6Umb8y0hzgcPZ9GKB/nvya83EH1vdFixf3l62H8qpRaejh0MJFZkkXib5Y0R6DJfK9NYxoOHlGg9xargd1tP5xq8aCWPRE4KflcVBEhwhC8iv2mtp4TggNZ6IRQYSCjBuccHY8j8lh58O/C1IhMSkQkcJCIjgYSOND7iR4fvGz806VJHOBMJx7/Ib7SC1lrkRhBhKou9bpVSvvzYXqCUSDyYO/h/1x4vVsqhNyT+LPuj1trEfhexpsAKidRaz4ho2mI2ow1cEdGDCVZore9iS4EdGTtmFWqtV7jhmEjM4yrGFNip1bocSATmAmI2GvwiEuJ0SGG0G9xzFNgTiWKpaSw31QDTWBLT2YqMzbCxxUUs+cyMyKK001AQB5EoHg55NWaOPtfX/SR4LZ3hLIKEbxZVYgct8DIHjdCJ3MFlIsf78Bm5agVngde87MNtsDxdXKcoiLzpwXVw8KyUyvxAV9cpCiJDxKNSam9pI9Q2eCJ91uxIYwPDZp6lpCBSTahtiD7wEXwQuYEBws5RnuCtKFNhMhiJxAMkiTQETnylh3IuwhhOfKi63QukiHzOdBYd9NYEDz098BYgQeQmZ3hkOiuKaElIkCAyqyi/hF4McQUGX89zhj5GLl6VUplRswxYjFoTiSqKpcW/topz3MQV86QL3Nwk8KS0FZF9ljpnqEvlIvtu6Kmg2mfQd9XhRGTO1QjZuNnVuUywwtd9Vh3n0G3fe3AtXaFS35UNujip91mVBS7awn6GAEogG+s4pdQHOOqlhcEB4GPOYLMisQZZKHGllGrNKMqC5kMdpvBaQeIEAyyahgCN+P1KRD+01ibFNkdxm1fsicRUDBc3JFQUZk1AooS6uQCpfxup57MSIZ/GGloB1n1JMH7qyWYwquunacP3sUJ/EQkRcy99gp7iSSk1P700IwZbaPEzc/rWWPViOEos4+ZiJtOoj89KqbJEdFtWpxG537E6RUptCidfwVqb1fmHglbrq+P367CFFVlr1AnqR1scTQnjonKEWU3z6F4cSxBpXgiX70ujAzKNpHBq9ZOYRSexIl1a17044h1UIJjSzhG3s7ovRLrA+IJezPoOxpeyxWya6lEBrPQxVsspXj343jd1IcMyJCJrUEamkQJKqWvo9z9g7W8ETnnL6dtMRFqgZmXu/25cN6XUCPre1Qp/aNoaHwKRj0T0G976l64uoo7M3P+toLPv6/63Bv8LWFSh70SaivL9EF+89XdC4osFkDmyuQYEV2qJr8Btk+hP34kscuA7rZeBe2BlJduu4gpY60pnIsvSQEIoCl913j3WxD1wJPPKdlVKrUhf4m6ej0XmCp+DAsjkThCxul+RDVwQBfnhfKBiZKPHLnFTp865SUc1Mgy6ArcSg4h+r4v4SO7Es/C4lVIZNjD5g4BDFKz2ZRUzdtA28CR1PAtsQmubhz3B8TFrxauo1Yo8n4RDXIUd3JJRoFMeOWrgpi5v6W3/SIiRrCOLW8meRzRbD5qiLEYgvrTaj3x2LOOk+xOjRmWET2WOE9jmP55dnC6wYhR1j6uah1tpPYfFte3ame8ROERWitYUNO8GnER4pRRLRHYD8X7MRGQH8DEoP6TxLKVAxKQJ1hUlkUEiCiIZYa/otiocqmjttM/Rx2D8WIgMrQFJXCLEQmRj46HjGa2cc1faAbEQKe6XeQaHyMqXdbArsqvMicNs2cqXNRYiObHYTx1tFcGagFLXFhEFkbhJjsHTRdkIx3+tLQONyf3grMpWgwIwsDiuT22yISYiOQMtrrLd2VsCd+jGcIhEzpIjXmdt6Er0c3AS7M82ifTYIjucksML33lSiNQH5tetVnFsRC6ZhcC3qAIUB8Jx3BeldA7QKaIiEiKIq/O+SJMp0ChrLWG8FV91Ca21ywDAV8xmd8oZwohyGfVyNF68DrESOcL4MS52KFtsvLE29KHrpqrm/NdNzh0lkXSwErkGRoYdjI1lla5CleAYYl0iRfa56UDCaIkkt16LMpjq9tNVMhIeFvGY2yrKGrETGdrA/EZ6MY+oiaSwyHRqSIq+1AMGw7jLlnULvLim1aJfkRl6vDLZ4jSPwRCZAaM8v/bjauSadAdHJB18vYVQlxgH4hvCDZJIOojaqYCv2QTGL535aJUfLJEZ4MzPUILha3ggO1Jki8ETmQErdIKPlEH0gqiQ910cEpEFyIXcxojc2BKb7fmxbruzOhFpCQTiyyoJtj46rJogERkJUn9kJEhExgAi+g/1Qv7cFT6QFQAAAABJRU5ErkJggg==

and the length of that is (i assume) why we use the tinyurl.

The problem with the tinyurl thing is that it's a) super fragile - the tinyurl can change at any time and so then we just have dead links. same thing with the shields.io API and also b) it puts effectively a tracking link in the readmes of all our packages.

It would be super simple to just make the badge available at, eg. https://pyopensci.org/badges/peer-reviewed.svg

going to follow up with PRs to this effect but wanted to open an issue to track them.

PRs:

@lwasser
Copy link
Member

lwasser commented Jul 22, 2024

@sneakers-the-rat i think i've now merged everything needed for this issue. Is our next step to reach out to maintainers and ask them to use this link instead in their readme?

@sneakers-the-rat
Copy link
Contributor Author

Do we want to wait on that until we figure out how to do package-specific badges? I figure one ask will be less of a pain than two.

There's one more way to do dynamic badging without needing to generate a zillion of the same svg file using htaccess files I want to try too btw, forgot github respects those

@sneakers-the-rat
Copy link
Contributor Author

Or wait, maybe thats only enterprise accounts? I seen it working over here: https://github.com/perma-id/w3id.org/blob/master/linkml/.htaccess

I also forgot about HTTP-REFRESH meta fields
https://github.com/jekyll/jekyll-redirect-from

@lwasser
Copy link
Member

lwasser commented Jul 22, 2024

oh right - i'm just getting caught back up and i forgot about that part. Sure -- let's think about package specific badges. I like your idea of hacking jekyll to do it 😆 especially if it's just a matter of parsing the YAML file (which will eventually be a database), looking at things like last commit date, peer review status, etc. then a cron job that runs weekly or something to that effect.

@lwasser
Copy link
Member

lwasser commented Jul 22, 2024

how would redirect from work? i've used that for page redirects but that just adds a refresh to the page meta (if i'm remembering correctly that is)

@sneakers-the-rat
Copy link
Contributor Author

sneakers-the-rat commented Jul 22, 2024

yeah right, i was just thinking maybe github's image resolver would maybe understand the refresh tag where it didn't understand the javascript? let me test real quick

![this should be an image](https://hackers.piracy.solutions/dynamic_img/my_pkg/)

this should be an image

edit: nope! ok generating all the images it is! that shouldn't be that hard.

@lwasser
Copy link
Member

lwasser commented Jul 23, 2024

sounds good!!

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

No branches or pull requests

2 participants