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

feat: Validate JOSS and Zenodo dois in a separate workflow #247

Open
lwasser opened this issue Jan 14, 2025 · 2 comments
Open

feat: Validate JOSS and Zenodo dois in a separate workflow #247

lwasser opened this issue Jan 14, 2025 · 2 comments

Comments

@lwasser
Copy link
Member

lwasser commented Jan 14, 2025

          > this is erroring on a review (bibat) which means there is an outlier format in archive that isn't being handled as we would like it to be handled.

Whoops! Not sure how I missed this on the first go around. I track this down and it was because the JOSS DOI field was left blank. I have updated the parser/validator to handle missing data like this in b6b9f27

When running it locally is that it hangs. I suspect it's slower because adding python-doi means we are parsing and checking urls / DOIs for each package. For now, we might consider adding more output so a user knows it's doing something. Maybe the package name it's processing in the terminal would be good to print out? I almost thought it was broken, and then I saw it was just processing but slower than it was previously.

Ooof, I didn't realize how much slower it was until now. Indeed it is the DOI validation step that is causing this slowdown. I can add a print statement, perhaps in this for-loop to indicate each package it is currently processing.

With this dramatic of a slow down, I'm considering not doing the full validation of the DOI URLs to ensure they resolve correctly. Perhaps these could be gathered and at the end of critical build steps like for the documentation we check these DOI URLs to validate that the resolve. For now, I'm adding a simple print statement in b25ebbc to indicate progress, but I think we should come back to this later.

Originally posted by @banesullivan in #243 (comment)

the above issue was noted by @banesullivan as we work on the DOI workflow.

One idea is that we build a separate doi validation workflow that runs independently once a month to notify us of incorrect dois. In theory, once we have a doi we shouldn't have to check it again. Maybe there is a way to adapt the workflow to only test new doi's and maybe we do it less frequently than every build.

For instance, in our contributor workflow, we start by processing existing contribs in the yml. file. idk if thre is something we could learn from there.

@banesullivan
Copy link
Contributor

build a separate doi validation workflow that runs independently once a month to notify us of incorrect dois

I like this idea! I could easily set up a dedicated script and GHA workflow to do this. Could even have the GHA comment on the problematic review issue noting that the DOI is invalid which would ping the original authors and editor for that review.

@lwasser lwasser changed the title Validation of DOI's feat: Validate JOSS and Zenodo dois in a separate workflow Jan 22, 2025
@lwasser
Copy link
Member Author

lwasser commented Jan 22, 2025

Perfect. We can come back to this in the future!

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