root icon indicating copy to clipboard operation
root copied to clipboard

[citation.cff] Add CITATION.cff and machinery to generate it from RelNotes: [skip-ci]

Open Axel-Naumann opened this issue 4 years ago • 10 comments

For that, reformat the author list in the relnotes to make it easier / more stable to parse. CITATION.cff, while generated, must be version controlled such that tooling can find it.

TODO: trigger in version target

Axel-Naumann avatar Jul 08 '21 07:07 Axel-Naumann

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14 How to customize builds

phsft-bot avatar Jul 08 '21 07:07 phsft-bot

Congratulations :tada:. DeepCode analyzed your code in 4.639 seconds and we found no issues. Enjoy a moment of no bugs :sunny:.

👉 View analysis in DeepCode’s Dashboard | Configure the bot

👉 The DeepCode service and API will be deprecated in August, 2021. Here is the information how to migrate. Thank you for using DeepCode 🙏 ❤️ !

If you are using our plugins, you might be interested in their successors: Snyk's JetBrains plugin and Snyk's VS Code plugin.

ghost avatar Jul 08 '21 08:07 ghost

Build failed on ROOT-debian10-i386/cxx14. Running on pcepsft10.dyndns.cern.ch:/build/workspace/root-pullrequests-build See console output.

Failing tests:

phsft-bot avatar Jul 08 '21 08:07 phsft-bot

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14 How to customize builds

phsft-bot avatar Jul 08 '21 09:07 phsft-bot

Starting build on ROOT-debian10-i386/cxx14, ROOT-performance-centos8-multicore/default, ROOT-ubuntu16/nortcxxmod, mac1014/python3, mac11.0/cxx17, windows10/cxx14 How to customize builds

phsft-bot avatar Jul 08 '21 10:07 phsft-bot

Thanks, @egpbos and @jspaaks ! Validation succeeds now.

suggest to add a GitHub Actions workflow

AFAICT we need this to be integrated with our release workflow. Once that's a GH Action we can also migrate the CITATION.cff generation and validation there. I think it's fairly hard to break the file given that it's generated by a script; I also dislike the pile of dependencies of cffconvert for a simple thing like validation, IMO it's too heavy to add it to the script producing CITATION.cff.

Axel-Naumann avatar Jul 08 '21 10:07 Axel-Naumann

IMO it's too heavy to add it to the script producing CITATION.cff

Makes sense.

What I would do in the GH Actions workflow would probably be something like:

  1. pip install and run the validation script there (so that it doesn't have to be included in the script, but can still be used to check PRs)
  2. Maybe also run makeCITATION.py and compare the output to the existing CITATION.cff file, just to make sure both files were updated.

But, again, can be added later. I'm not sure how much you want to depend on GitHub Actions anyway, perhaps it makes more sense to automate things elsewhere.

egpbos avatar Jul 08 '21 10:07 egpbos

Sorry, I pressed the wrong button, it's now undrafted 🤦 I wanted to approve.

egpbos avatar Jul 08 '21 10:07 egpbos

Topics to discuss:

  • generating the author list from release notes is wrong, as I just realized. Those are just those people who contributed to that version, but generally don't include earlier authors. Can we use "ROOT team" as author? Or should we take everyone from README/CREDITS? Or should we skip it, at the cost of a lack of (computer-) identifiable attributions?
  • we want people who dislike using Zenodo to cite the paper. Actually, very few cite Zenodo. How do we embed that paper in CITATION.cff, with references? What does the BibTeX file looks like for that?

Happy to hear @jspaaks 's comments here - I do realize that some of these issues are non-technical, but I bet you've encountered them before :-)

Axel-Naumann avatar Jul 08 '21 10:07 Axel-Naumann

Build failed on ROOT-debian10-i386/cxx14. Running on pcepsft11.dyndns.cern.ch:/home/sftnight/build/workspace/root-pullrequests-build See console output.

Failing tests:

phsft-bot avatar Jul 08 '21 12:07 phsft-bot