Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Documentation] Create CITATION.cff #4752

Merged
merged 3 commits into from Mar 9, 2023
Merged

[Documentation] Create CITATION.cff #4752

merged 3 commits into from Mar 9, 2023

Commits on Mar 9, 2023

  1. docs: Create CITATION.cff 

    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
    kevinmatthes committed Mar 9, 2023
    Copy the full SHA
    37f8ae2 View commit details
    Browse the repository at this point in the history

  2. docs: Add Replacement Rules for CITATION.cff 

    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
    kevinmatthes committed Mar 9, 2023
    Copy the full SHA
    ee8231c View commit details
    Browse the repository at this point in the history

  3. test: Add CFF Validation 

    The CITATION.cff is validated with the official GitHub Action.
    @kevinmatthes
    kevinmatthes committed Mar 9, 2023
    Copy the full SHA
    b8021a2 View commit details
    Browse the repository at this point in the history