Setup CITATION.cff

[kevinmatthes]

This PR adds a basic setup for citation metadata powered by CITATION.cff, as discussed in #210. (Please note that any papers citing this project using these information are yet to be written. 😉)

[kevinmatthes]

I commented the introduced changes to explain their purpose. Please have a look at it and tell me whether further adjustments are required.

[kevinmatthes]

The next step is to discuss the actual implementation of the update automation for the CITATION.cff. The update steps are rather straightforward: replacing the old version with the new one and updating the release date to "today".

Is there any workflow I can put the two required sed commands or do you use cargo-release?

[sourcefrog]

The next step is to discuss the actual implementation of the update automation for the CITATION.cff. The update steps are rather straightforward: replacing the old version with the new one and updating the release date to "today".

Is there any workflow I can put the two required sed commands or do you use cargo-release?

I have just been doing it manually and thinking that I should find a tool to automate it. Rather than adding sed commands let's do that now...? Maybe cargo-release is a good choice. It looks like we could configure it to update this file. Filed #213

[sourcefrog]

👍🏻 to merge if you feel it's ready.

[kevinmatthes]

@sourcefrog

You can go ahead and merge this PR. I will submit a separate PR for the automatic maintenance (#213).

[kevinmatthes]

The tests are not running because the Docker image for the validation tool is not a trusted Action, yet. How to fix this problem, @sourcefrog?

[sourcefrog]

Thanks for diagnosing it. I can add it to the allowlist.

[kevinmatthes]

I will close and reopen this PR to have the tests run once again.

[sourcefrog]

I looked at the Actions docs and I couldn't see how to allow Docker containers.

On the whole this doesn't seem like a file that is likely to be edited very often at all (other than version bumps) and so it's not really important to have it automatically validated. So, could you remove that for now and we'll just add the file?

[kevinmatthes]

Yes, no problem. I will remove the test. 👍

[kevinmatthes]

I just updated the version and date-released fields to refer to today's release. You can go ahead and merge this PR, I removed the test as you requested.