napari / napari

napari: a fast, interactive, multi-dimensional image viewer for python
https://napari.org
BSD 3-Clause "New" or "Revised" License
2.09k stars 411 forks source link

Fix citation cff and add worflow for future validation #6888

Closed Czaki closed 3 weeks ago

Czaki commented 4 weeks ago

Description

We have a problem that there is no entry on zenodo for napari for 0.4.19 release line. It lokks like some PR (most probably mine) broke the citation cff format.

I have validated and fixed field based on cffconvert python package. I also added GitHub actions for validate file content based on official documentaion https://github.com/citation-file-format/citation-file-format/blob/main/README.md

I'm not 100% sure that it will be enough to fix it, but it looks required for that.

codecov[bot] commented 4 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.44%. Comparing base (36bb0d3) to head (82e6fd6).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #6888 +/- ## ========================================== - Coverage 92.45% 92.44% -0.02% ========================================== Files 617 617 Lines 55161 55161 ========================================== - Hits 50998 50991 -7 - Misses 4163 4170 +7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jni commented 4 weeks ago

Thanks @Czaki!

Additionally I would like to reorder the author list — if it has to be automatic then I suggest by number of commits, but I'm open to other suggestions, including e.g. 1st core devs alphabetical then by commits. But all alphabetical is very weird. Personally I think "Sofroniew N, Lambert T, et al" is still a good reference for now.

jni commented 4 weeks ago

(of course, this can come in a different PR.)

brisvag commented 4 weeks ago

Can we manually trigger the entry on zenodo for 0.4.19?

jni commented 4 weeks ago

Apparently you can manually edit Zenodo entries so I'll try to get in touch with Nick (who I believe set this up back in the day) to see if we can put credentials/ownership in the joint 1Password account and then we can edit the entry. But let's get the metadata being generated correctly on main first.

brisvag commented 4 weeks ago

Yup I mean after this PR :P I'd say let's merge immediately, not much controversial here.

Czaki commented 4 weeks ago

if it has to be automatic then I suggest by number of commits (of course, this can come in a different PR.)

obraz

Not so many commits left.

In general, this is manual (I use a simple script for sort). I may think to develop script for updating and validate citation.cff (to fail CI when author is not added to citation file). But in such a situation we may think to switch from CITATION.cff to .zenodo.json as it offer two roles (creator and contributtror) https://developers.zenodo.org/#representation

In the past, a few persons (for example, Robert Hasse rejected to be added to citation file as they felt that contribution was too small).

If we still use CITATION.cff I prefer order:

1) Core-dev 2) emeritus core-dev 3) other contributors

Each group alphabetically.

Czaki commented 3 weeks ago

@jni What are your preferences to above statements?

jni commented 3 weeks ago

I need to think about it, which is why I decided to just merge. 😂

Czaki commented 3 weeks ago

I need to think about it, which is why I decided to just merge. 😂

May you open issue with this problem? I think that you could better summarize it and it will be easier to point problem to other core devs.