[Documentation] Create CITATION.cff #4752
Conversation
|
This PR introduces a CITATION.cff, valid according to CFF v1.2.0. There is plenty of tooling related to CFF, including a GitHub Action for validation as well as one for automatically updating the release date. These two, together with a version incrementing solution, make the CITATION.cff self-maintaining. Would some of the extensions to CFF be interesting? |
It'd be worth trying. My main concern is performance. I assume it shouldn't be too slow
We do this kind of stuff with cargo-release. Could you update the config so that it updates the date and version? You can |
kevinmatthes
force-pushed
the
feature/cff
branch
from
6e3ea6a to
f834fd4
Compare
|
The validation Action usually takes about 10 seconds to succeed, when being a workflow on its own, the total duration is usually about 30 seconds. Giving it a workflow on its own is useful to configure the trigger condition to be changes to CITATION.cff. I will try introduce the CITATION.cff to |
The downside to specialized triggers is you can't block merge on them. 10-30 seconds is fine to add to CI and always run. If its added to |
|
Okay, I will add it to the CI. |
CFF is a technology to make software citable. Therefore, a file named CITATION.cff needs to be stored in the repository's root. GitHub will then render a "Cite this repository" blob from it on the repository's landing page.
kevinmatthes
force-pushed
the
feature/cff
branch
from
f834fd4 to
37f8ae2
Compare
The regular expression for the release date update is taken from the GitHub Action `kevinmatthes/cff-release-today@v0.5.2` which uses this one, too. License issues should not arise as I am the author of that GitHub Action. The regular expression for the version update is designed to also work with version parts consisting of multiple digits. It was tested successfully with the example versions `1.2.3` and `1.2.30` in CITATION.cff.
kevinmatthes
force-pushed
the
feature/cff
branch
from
db85bf5 to
ee8231c
Compare
The CITATION.cff is validated with the official GitHub Action.
|
All requested changes are implemented. |
|
Thanks! |
This PR introduces a CITATION.cff (#4750 ), valid according to CFF v1.2.0.