Add CITATION.cff

[olebole]

See https://citation-file-format.github.io/

There is a discussion on citation-file-format/citation-file-format#436 about his.

Closes: citation-file-format/citation-file-format#436

[kevinmatthes]

I added some comments on the basic setup. It already looks very good! There are just some small details I would like to ask you to adjust; see my comments below.

Furthermore, there is a GitHub Action to validate a CFF. I would recommend to set up the Action in order to make sure that your CFF is always valid. The job would be the following:

  cffconvert:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          persist-credentials: false
      - uses: citation-file-format/[email protected]
        with:
          args: --validate

The workflow takes only 10 seconds to determine a result (valid / invalid) and takes in sum only 30 seconds when also considering the setup overhead. Just add the above job to any already existing GitHub Action workflow which always runs or create a new workflow file.

[kevinmatthes]

In addition to the already mentioned GitHub Action, there are also further integrations available in order to maintain and interact with CFFs, such as an Action to automatically update the release date of the software on release or a CLI to cite further works of which you have the CFF data in the references section of your CFF.

If you need help with the CFF or some integrations for it, I can help you.

[olebole]

@kevinmatthes Thank you for your help! I resolved all issues and now the validation passes.

I moved the CFF validation to an extra workflow and made it run on CITATION.cff changes only, because the file will change very rarely. I think that a further automation is not required, because the file needs an update only with a new version, which happens at most once per year; and then I can update by hand.