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

BUG: Check failing links caught by lychee #517

Open
willingc opened this issue Nov 18, 2024 · 6 comments
Open

BUG: Check failing links caught by lychee #517

willingc opened this issue Nov 18, 2024 · 6 comments
Assignees
Labels
bug Something isn't working

Comments

@willingc
Copy link
Collaborator

https://github.com/pyOpenSci/pyopensci.github.io/actions/runs/11896635143

@willingc willingc added the bug Something isn't working label Nov 18, 2024
@lwasser
Copy link
Member

lwasser commented Nov 19, 2024

thanks @willingc I was just about to open an issue!!

we encountered this in #521 #520 as well! so this is clearly an issue. i'm hoping to have someone to help fix some of these items soon!! they are being onboarded right now!! This is an odd one as from what i can see the zenodo links do work. i'm not sure what file it can't find. should we ignore zenodo links? could it be that Lychee is trying to hit Zenodo over and over for every package listed and failing?

@pllim
Copy link
Contributor

pllim commented Nov 20, 2024

Is this the error this issue is supposed to be about? Because I cannot make sense of it either.

Error: R] [file:///home/runner/work/pyopensci.github.io/pyopensci.github.io/_site/[![DOI](https:/zenodo.org/badge/142608764.svg)](https:/zenodo.org/badge/latestdoi/142608764)](file:///home/runner/work/pyopensci.github.io/pyopensci.github.io/_site/[![DOI](https:/zenodo.org/badge/142608764.svg)](https:/zenodo.org/badge/latestdoi/142608764)) | Failed: Cannot find file
Error: R] [file:///home/runner/work/pyopensci.github.io/pyopensci.github.io/_site/[![DOI](https:/zenodo.org/badge/DOI/10.5281/zenodo.10951577.svg)](https:/doi.org/10.5281/zenodo.10951577)](file:///home/runner/work/pyopensci.github.io/pyopensci.github.io/_site/[![DOI](https:/zenodo.org/badge/DOI/10.5281/zenodo.10951577.svg)](https:/doi.org/10.5281/zenodo.10951577)) | Failed: Cannot find file

It claims not to be able to find file but it is brute-force appending a markdown into a URL. It makes no sense.

@pllim
Copy link
Contributor

pllim commented Nov 20, 2024

The astropy one was fixed in #520 and now there is a new one that needs upstream fix at phenopype/phenopype#5 . But the DOI ones are perplexing.

@lwasser
Copy link
Member

lwasser commented Nov 20, 2024

Ok i found one real issue that could be behind some of this and then @pllim a few other issues too that we can address in a separate issue.

if you go to the sourmash badge on our package listing page, the JOSS doi is listed as a badge in our yaml file. This is fine if we want to publish the badge on our cards, which I'd love to do! However, because the cards are parsed using a combination of liquid and html here jekyll tries to create a crazy link using the badge markdown which doesn't work.

So, I think I have to figure out a way to parse the DOI badge using HTML in that included file. i'm going to try to push a pr that just prints the badge markdown badge to see if that works. If so, we can likely parse the doi badge differently via pyos meta (i think) to address this.

I also noticed (separate issue) that astropy affiliated badges are not rendering (but the sunpy one is!)

test pr to see if this fixes everything or just one thing coming soon...

@lwasser
Copy link
Member

lwasser commented Nov 21, 2024

Ok yes i think this is the issue. We need to decide how we want to collect DOI and archive information. i think right now

xclim:
pyOpenSci/software-submission#73 has the badges in those parts of our template. if that badge is there, I can parse the barge into an HTML link with no problem using Liquid and HTML which is what #524 does.

Sourmash has the same issue . i'll submit another commit to parse the zenodo archive badge.

the thing that will be trick is sometimes people add this information differently in our template. We can add a note to the template but we've have to update how pyos parses that field. these are all challenges related to parsing text that people enter! (and why i wish we had a form with validation setup)

@lwasser
Copy link
Member

lwasser commented Nov 21, 2024

And the plot thickens...

Sometimes people use the latest version of the doi
archive: 'DOI'

other times they use the doing associated with teh specific version accepted (what they should do)

archive: 'DOI'

We could catch this with Pyosmeta, however, and raise a flag on the card that it's incorrect. that could motivate people to fix things?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants