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

Use of cffconvert to create .zenodo.json file completely removes grants #2825

Open
valeriupredoi opened this issue Oct 4, 2022 · 9 comments
Assignees
Labels

Comments

@valeriupredoi
Copy link
Contributor

valeriupredoi commented Oct 4, 2022

cffconvert --format zenodo --outfile .zenodo.json - the JSON file is correct syntactically and holds all the authors but removes stuff like grants or communities. I think it's got something to do with the now non-existent option of ignoring dodgy items as it was in the past version of cffconvert. Let me dig around.

@valeriupredoi
Copy link
Contributor Author

OK guys I went asking at the source citation-file-format/cffconvert#286

@valeriupredoi
Copy link
Contributor Author

Right - so I got a very nice and detailed reply from the main dev/builder of cffconvert in this comment - it basically boils down to the new version will not preserve the keys like grants or communities but they're working on a workaround (not their fault actually, it's Zenodo) - I propose we either drop those sections for now til the workaround comes online, or we pin the converter version, or we do nothing - what say you @bouweandela @remi-kazeroni

@remi-kazeroni
Copy link
Contributor

I think it would be quite unfortunate to remove keys like "grants" and "communities". Releasing v2.7 with grants like is-enes is not ideal (with my corporate hat on!). Doing nothing is also not ideal because we want to fully acknowledge Jerry's contribution in #2774... We could simply add Jerry to .zenodo.json but then I noticed that we would have one more contributor in .zenodo.json than in CITATION.cff because one contributor was not added to CITATION.cff... All in all, I think the best is to pin the converter to a version that does not remove "grants" and "communities", rerun it before the release, and later unpin when the issue while be solved on the converter side. Would that work for you @valeriupredoi?

@bouweandela
Copy link
Member

bouweandela commented Oct 6, 2022

From @jspaaks's comment, it looks like .zenodo.json isn't used at all by Zenodo if you have a CITATION.cff. Until that is fixed, we will need to manually edit our Zenodo entries after they are created so they include communities and grants.

Regarding adding contributors: we can manually add them to CITATION.cff and use the converter to create .zenodo.json, just make sure to not commit any changes to communities and grants (e.g. use git add -p), as already described in the ESMValCore documentation: https://docs.esmvaltool.org/projects/esmvalcore/en/latest/contributing.html#list-of-authors

@bouweandela bouweandela changed the title New use of cffconvert to create .zenodo.json file completely removes grants Use of cffconvert to create .zenodo.json file completely removes grants Oct 6, 2022
@bouweandela
Copy link
Member

Unfortunately it is not possible to share edit rights on our Zenodo repositories yet zenodo/zenodo#151. I will try to figure out who has those rights, I suspect it's @nielsdrost.

@bouweandela
Copy link
Member

It is @mattiarighi. I've created a new Zenodo user called esmvaltool_tech_lead_team using the tech lead team email address and we're trying to transfer ownership of the repositories to that user.

@valeriupredoi
Copy link
Contributor Author

valeriupredoi commented Oct 7, 2022

cheers a much for all your Zenodo tribulations, @bouweandela - can we now close this or we still have to figure out a way to get those keys in in an automated way? 🍺

@bouweandela
Copy link
Member

It would be best to copy the advice on not removing communities and grants from .zenodo.json from the ESMValCore docs to the ESMValTool docs to avoid having this discussion again in a few month's time.

@valeriupredoi
Copy link
Contributor Author

would you be a sweetiepie and do that pls @bouweandela 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants