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: Problem with how partners field is parsed + tests #186

Closed
lwasser opened this issue Jul 11, 2024 · 4 comments · Fixed by #187
Closed

bug: Problem with how partners field is parsed + tests #186

lwasser opened this issue Jul 11, 2024 · 4 comments · Fixed by #187
Labels
bug Something isn't working help wanted Extra attention is needed python-code An issue related to python / requiring python coding skills sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Jul 11, 2024

Right now, the partners field for astropy specifically, looks like this as an output:

https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/packages.yml#L81

  partners:
    - 'astropy: link-coming soon-to standards'

this is breaking the build on the astropy side of things - see here.

the partners field should always serialize to single word partner names like this:

  partners:
    - 'astropy: link-coming soon-to standards'

note: We should add some tests to ensure that the model captures / serializes fields correctly. let's start with a test for the partners field when this is fixed.

cc: @pllim

@lwasser lwasser added bug Something isn't working help wanted Extra attention is needed sprintable python-code An issue related to python / requiring python coding skills labels Jul 11, 2024
@pllim
Copy link
Contributor

pllim commented Jul 11, 2024

Thanks! Does this mean my patch over at astropy/astropy.github.com#605 is irrelevant or still applies?

@lwasser
Copy link
Member Author

lwasser commented Jul 11, 2024

@pllim your patch accounts for this bug. but once we fix this bug your patch won't be necessary if that makes sense. so if you are ok with it potentially taking a bit of time to fix this bug depending on who has time -- (i'm at scipy) - then you dont need that patch!

we should be able to fix this quickly once we have time. we just need to make the partners field a Literal as @sneakers-the-rat mentioned and a validator that just uses "starts with" i think the check / clean / ingest the correct partner value

@pllim
Copy link
Contributor

pllim commented Jul 11, 2024

Well, the website isn't showing anything is kinda shocking, so I think I will just merge what I have downstream so things are fixed for now. If the patch is compatible with your future fix, then it does not hurt anyway, right? Thanks for the advice!

@lwasser
Copy link
Member Author

lwasser commented Jul 11, 2024

nope - it will NOT hurt to merge that! i'm sorry about this complication. we are working on tests for this build so we know about these changes in the future BEFORE they are ingested into our website build!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed python-code An issue related to python / requiring python coding skills sprintable
Projects
Development

Successfully merging a pull request may close this issue.

2 participants